veryhigh.rst 16.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
.. highlightlang:: c


.. _veryhigh:

*************************
The Very High Level Layer
*************************

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 :const:`Py_eval_input`,
:const:`Py_file_input`, and :const:`Py_single_input`.  These are described
following the functions which accept them as parameters.

19 20
Note also that several of these functions take :c:type:`FILE\*` parameters.  One
particular issue which needs to be handled carefully is that the :c:type:`FILE`
21 22
structure for different C libraries can be different and incompatible.  Under
Windows (at least), it is possible for dynamically linked extensions to actually
23
use different libraries, so care should be taken that :c:type:`FILE\*` parameters
24 25 26 27
are only passed to these functions if it is certain that they were created by
the same library that the Python runtime is using.


28
.. c:function:: int Py_Main(int argc, wchar_t **argv)
29

30 31 32 33 34 35 36 37 38
   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 :c:func:`main`
   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 ``0`` if the interpreter exits normally (i.e., without an exception),
   ``1`` if the interpreter exits due to an exception, or ``2`` if the parameter
   list does not represent a valid Python command line.
39

40
   Note that if an otherwise unhandled :exc:`SystemExit` is raised, this
Benjamin Peterson's avatar
Benjamin Peterson committed
41 42 43
   function will not return ``1``, but exit the process, as long as
   ``Py_InspectFlag`` is not set.

44

45
.. c:function:: int PyRun_AnyFile(FILE *fp, const char *filename)
46

47
   This is a simplified interface to :c:func:`PyRun_AnyFileExFlags` below, leaving
48 49 50
   *closeit* set to ``0`` and *flags* set to *NULL*.


51
.. c:function:: int PyRun_AnyFileFlags(FILE *fp, const char *filename, PyCompilerFlags *flags)
52

53
   This is a simplified interface to :c:func:`PyRun_AnyFileExFlags` below, leaving
54 55 56
   the *closeit* argument set to ``0``.


57
.. c:function:: int PyRun_AnyFileEx(FILE *fp, const char *filename, int closeit)
58

59
   This is a simplified interface to :c:func:`PyRun_AnyFileExFlags` below, leaving
60 61 62
   the *flags* argument set to *NULL*.


63
.. c:function:: int PyRun_AnyFileExFlags(FILE *fp, const char *filename, int closeit, PyCompilerFlags *flags)
64 65 66

   If *fp* refers to a file associated with an interactive device (console or
   terminal input or Unix pseudo-terminal), return the value of
67
   :c:func:`PyRun_InteractiveLoop`, otherwise return the result of
68 69 70
   :c:func:`PyRun_SimpleFile`.  *filename* is decoded from the filesystem
   encoding (:func:`sys.getfilesystemencoding`).  If *filename* is *NULL*, this
   function uses ``"???"`` as the filename.
71 72


73
.. c:function:: int PyRun_SimpleString(const char *command)
74

75
   This is a simplified interface to :c:func:`PyRun_SimpleStringFlags` below,
76 77 78
   leaving the *PyCompilerFlags\** argument set to NULL.


79
.. c:function:: int PyRun_SimpleStringFlags(const char *command, PyCompilerFlags *flags)
80 81 82 83 84 85 86

   Executes the Python source code from *command* in the :mod:`__main__` module
   according to the *flags* argument. If :mod:`__main__` does not already exist, it
   is created.  Returns ``0`` on success or ``-1`` 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.

87
   Note that if an otherwise unhandled :exc:`SystemExit` is raised, this
Benjamin Peterson's avatar
Benjamin Peterson committed
88 89 90
   function will not return ``-1``, but exit the process, as long as
   ``Py_InspectFlag`` is not set.

91

92
.. c:function:: int PyRun_SimpleFile(FILE *fp, const char *filename)
93

94
   This is a simplified interface to :c:func:`PyRun_SimpleFileExFlags` below,
95 96 97
   leaving *closeit* set to ``0`` and *flags* set to *NULL*.


98
.. c:function:: int PyRun_SimpleFileEx(FILE *fp, const char *filename, int closeit)
99

100
   This is a simplified interface to :c:func:`PyRun_SimpleFileExFlags` below,
101 102 103
   leaving *flags* set to *NULL*.


104
.. c:function:: int PyRun_SimpleFileExFlags(FILE *fp, const char *filename, int closeit, PyCompilerFlags *flags)
105

106
   Similar to :c:func:`PyRun_SimpleStringFlags`, but the Python source code is read
107 108 109 110
   from *fp* instead of an in-memory string. *filename* should be the name of
   the file, it is decoded from the filesystem encoding
   (:func:`sys.getfilesystemencoding`).  If *closeit* is true, the file is
   closed before PyRun_SimpleFileExFlags returns.
111 112


113
.. c:function:: int PyRun_InteractiveOne(FILE *fp, const char *filename)
114

115
   This is a simplified interface to :c:func:`PyRun_InteractiveOneFlags` below,
116 117 118
   leaving *flags* set to *NULL*.


119
.. c:function:: int PyRun_InteractiveOneFlags(FILE *fp, const char *filename, PyCompilerFlags *flags)
120

121 122
   Read and execute a single statement from a file associated with an
   interactive device according to the *flags* argument.  The user will be
123 124 125 126
   prompted using ``sys.ps1`` and ``sys.ps2``.  *filename* is decoded from the
   filesystem encoding (:func:`sys.getfilesystemencoding`).

   Returns ``0`` when the input was
127 128 129 130
   executed successfully, ``-1`` if there was an exception, or an error code
   from the :file:`errcode.h` include file distributed as part of Python if
   there was a parse error.  (Note that :file:`errcode.h` is not included by
   :file:`Python.h`, so must be included specifically if needed.)
131 132


133
.. c:function:: int PyRun_InteractiveLoop(FILE *fp, const char *filename)
134

135
   This is a simplified interface to :c:func:`PyRun_InteractiveLoopFlags` below,
136 137 138
   leaving *flags* set to *NULL*.


139
.. c:function:: int PyRun_InteractiveLoopFlags(FILE *fp, const char *filename, PyCompilerFlags *flags)
140 141

   Read and execute statements from a file associated with an interactive device
142
   until EOF is reached.  The user will be prompted using ``sys.ps1`` and
143 144
   ``sys.ps2``.  *filename* is decoded from the filesystem encoding
   (:func:`sys.getfilesystemencoding`).  Returns ``0`` at EOF.
145 146


147 148 149 150 151 152 153 154 155 156 157
.. c:var:: int (*PyOS_InputHook)(void)

   Can be set to point to a function with the prototype
   ``int func(void)``.  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 :file:`Modules/_tkinter.c` in the
   Python source code.


158
.. c:var:: char* (*PyOS_ReadlineFunctionPointer)(FILE *, FILE *, const char *)
159 160 161 162 163 164 165 166 167 168

   Can be set to point to a function with the prototype
   ``char *func(FILE *stdin, FILE *stdout, char *prompt)``,
   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 *NULL*, and then read a line of
   input from the provided standard input file, returning the
   resulting string.  For example, The :mod:`readline` module sets
   this hook to provide line-editing and tab-completion features.

169 170 171 172 173 174 175 176
   The result must be a string allocated by :c:func:`PyMem_RawMalloc` or
   :c:func:`PyMem_RawRealloc`, or *NULL* if an error occurred.

   .. versionchanged:: 3.4
      The result must be allocated by :c:func:`PyMem_RawMalloc` or
      :c:func:`PyMem_RawRealloc`, instead of being allocated by
      :c:func:`PyMem_Malloc` or :c:func:`PyMem_Realloc`.

177

178
.. c:function:: struct _node* PyParser_SimpleParseString(const char *str, int start)
179 180

   This is a simplified interface to
181
   :c:func:`PyParser_SimpleParseStringFlagsFilename` below, leaving  *filename* set
182 183 184
   to *NULL* and *flags* set to ``0``.


185
.. c:function:: struct _node* PyParser_SimpleParseStringFlags( const char *str, int start, int flags)
186 187

   This is a simplified interface to
188
   :c:func:`PyParser_SimpleParseStringFlagsFilename` below, leaving  *filename* set
189 190 191
   to *NULL*.


192
.. c:function:: struct _node* PyParser_SimpleParseStringFlagsFilename( const char *str, const char *filename, int start, int flags)
193 194 195 196

   Parse Python source code from *str* using the start token *start* according to
   the *flags* argument.  The result can be used to create a code object which can
   be evaluated efficiently. This is useful if a code fragment must be evaluated
197 198
   many times. *filename* is decoded from the filesystem encoding
   (:func:`sys.getfilesystemencoding`).
199 200


201
.. c:function:: struct _node* PyParser_SimpleParseFile(FILE *fp, const char *filename, int start)
202

203
   This is a simplified interface to :c:func:`PyParser_SimpleParseFileFlags` below,
204
   leaving *flags* set to ``0``.
205 206


207
.. c:function:: struct _node* PyParser_SimpleParseFileFlags(FILE *fp, const char *filename, int start, int flags)
208

209
   Similar to :c:func:`PyParser_SimpleParseStringFlagsFilename`, but the Python
210 211 212
   source code is read from *fp* instead of an in-memory string.


213
.. c:function:: PyObject* PyRun_String(const char *str, int start, PyObject *globals, PyObject *locals)
214

215
   This is a simplified interface to :c:func:`PyRun_StringFlags` below, leaving
216 217 218
   *flags* set to *NULL*.


219
.. c:function:: PyObject* PyRun_StringFlags(const char *str, int start, PyObject *globals, PyObject *locals, PyCompilerFlags *flags)
220 221

   Execute Python source code from *str* in the context specified by the
222 223 224 225
   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.
226 227 228 229 230

   Returns the result of executing the code as a Python object, or *NULL* if an
   exception was raised.


231
.. c:function:: PyObject* PyRun_File(FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals)
232

233
   This is a simplified interface to :c:func:`PyRun_FileExFlags` below, leaving
234 235 236
   *closeit* set to ``0`` and *flags* set to *NULL*.


237
.. c:function:: PyObject* PyRun_FileEx(FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals, int closeit)
238

239
   This is a simplified interface to :c:func:`PyRun_FileExFlags` below, leaving
240 241 242
   *flags* set to *NULL*.


243
.. c:function:: PyObject* PyRun_FileFlags(FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals, PyCompilerFlags *flags)
244

245
   This is a simplified interface to :c:func:`PyRun_FileExFlags` below, leaving
246 247 248
   *closeit* set to ``0``.


249
.. c:function:: PyObject* PyRun_FileExFlags(FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals, int closeit, PyCompilerFlags *flags)
250

251
   Similar to :c:func:`PyRun_StringFlags`, but the Python source code is read from
252 253
   *fp* instead of an in-memory string. *filename* should be the name of the file,
   it is decoded from the filesystem encoding (:func:`sys.getfilesystemencoding`).
254
   If *closeit* is true, the file is closed before :c:func:`PyRun_FileExFlags`
255 256 257
   returns.


258
.. c:function:: PyObject* Py_CompileString(const char *str, const char *filename, int start)
259

260
   This is a simplified interface to :c:func:`Py_CompileStringFlags` below, leaving
261 262 263
   *flags* set to *NULL*.


264
.. c:function:: PyObject* Py_CompileStringFlags(const char *str, const char *filename, int start, PyCompilerFlags *flags)
265

266 267 268 269
   This is a simplified interface to :c:func:`Py_CompileStringExFlags` below, with
   *optimize* set to ``-1``.


270
.. c:function:: PyObject* Py_CompileStringObject(const char *str, PyObject *filename, int start, PyCompilerFlags *flags, int optimize)
271

272 273 274 275 276
   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 :const:`Py_eval_input`,
   :const:`Py_file_input`, or :const:`Py_single_input`.  The filename specified by
   *filename* is used to construct the code object and may appear in tracebacks or
277 278
   :exc:`SyntaxError` exception messages.  This returns *NULL* if the code
   cannot be parsed or compiled.
279

280 281 282 283 284 285
   The integer *optimize* specifies the optimization level of the compiler; a
   value of ``-1`` selects the optimization level of the interpreter as given by
   :option:`-O` options.  Explicit levels are ``0`` (no optimization;
   ``__debug__`` is true), ``1`` (asserts are removed, ``__debug__`` is false)
   or ``2`` (docstrings are removed too).

286
   .. versionadded:: 3.4
287

288

289 290
.. c:function:: PyObject* Py_CompileStringExFlags(const char *str, const char *filename, int start, PyCompilerFlags *flags, int optimize)

291
   Like :c:func:`Py_CompileStringObject`, but *filename* is a byte string
292 293 294 295
   decoded from the filesystem encoding (:func:`os.fsdecode`).

   .. versionadded:: 3.2

296
.. c:function:: PyObject* PyEval_EvalCode(PyObject *co, PyObject *globals, PyObject *locals)
297

298
   This is a simplified interface to :c:func:`PyEval_EvalCodeEx`, with just
299 300
   the code object, and global and local variables.  The other arguments are
   set to *NULL*.
301 302


303
.. c:function:: PyObject* PyEval_EvalCodeEx(PyObject *co, PyObject *globals, PyObject *locals, PyObject **args, int argcount, PyObject **kws, int kwcount, PyObject **defs, int defcount, PyObject *kwdefs, PyObject *closure)
304 305

   Evaluate a precompiled code object, given a particular environment for its
306 307
   evaluation.  This environment consists of a dictionary of global variables,
   a mapping object of local variables, arrays of arguments, keywords and
308 309
   defaults, a dictionary of default values for :ref:`keyword-only\
   <keyword-only_parameter>` arguments and a closure tuple of cells.
310 311


312 313 314 315 316 317
.. c:type:: PyFrameObject

   The C structure of the objects used to describe frame objects. The
   fields of this type are subject to change at any time.


318
.. c:function:: PyObject* PyEval_EvalFrame(PyFrameObject *f)
319 320

   Evaluate an execution frame.  This is a simplified interface to
321
   :c:func:`PyEval_EvalFrameEx`, for backward compatibility.
322 323


324
.. c:function:: PyObject* PyEval_EvalFrameEx(PyFrameObject *f, int throwflag)
325 326 327 328 329 330

   This is the main, unvarnished function of Python interpretation.  It is
   literally 2000 lines long.  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
331
   :meth:`~generator.throw` methods of generator objects.
332

333 334 335 336
   .. versionchanged:: 3.4
      This function now includes a debug assertion to help ensure that it
      does not silently discard an active exception.

337

338
.. c:function:: int PyEval_MergeCompilerFlags(PyCompilerFlags *cf)
339 340 341 342 343

   This function changes the flags of the current evaluation frame, and returns
   true on success, false on failure.


344
.. c:var:: int Py_eval_input
345 346 347 348

   .. index:: single: Py_CompileString()

   The start symbol from the Python grammar for isolated expressions; for use with
349
   :c:func:`Py_CompileString`.
350 351


352
.. c:var:: int Py_file_input
353 354 355 356

   .. index:: single: Py_CompileString()

   The start symbol from the Python grammar for sequences of statements as read
357
   from a file or other source; for use with :c:func:`Py_CompileString`.  This is
358 359 360
   the symbol to use when compiling arbitrarily long Python source code.


361
.. c:var:: int Py_single_input
362 363 364 365

   .. index:: single: Py_CompileString()

   The start symbol from the Python grammar for a single statement; for use with
366
   :c:func:`Py_CompileString`. This is the symbol used for the interactive
367 368 369
   interpreter loop.


370
.. c:type:: struct PyCompilerFlags
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385

   This is the structure used to hold compiler flags.  In cases where code is only
   being compiled, it is passed as ``int flags``, and in cases where code is being
   executed, it is passed as ``PyCompilerFlags *flags``.  In this case, ``from
   __future__ import`` can modify *flags*.

   Whenever ``PyCompilerFlags *flags`` is *NULL*, :attr:`cf_flags` is treated as
   equal to ``0``, and any modification due to ``from __future__ import`` is
   discarded.  ::

      struct PyCompilerFlags {
          int cf_flags;
      }


386
.. c:var:: int CO_FUTURE_DIVISION
387 388 389

   This bit can be set in *flags* to cause division operator ``/`` to be
   interpreted as "true division" according to :pep:`238`.