< BACKMake Note | BookmarkCONTINUE >
152015024128143245168232148039196038240039088173205162105045222218072221085031055118075

The Very High Level Layer

The functions in this section 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 Py_eval_input, Py_file_input, and Py_single_input. These are described following the functions that accept them as parameters.

					
int PyRun_AnyFile(FILE *fp, char *filename)

				

If fp refers to a file associated with an interactive device (console or terminal input or UNIX pseudo-terminal), returns the value of PyRun_InteractiveLoop(), otherwise returns the result of PyRun_SimpleFile(). If filename is NULL, use "???" as the filename.

					
int PyRun_SimpleString(char *command)

				

Executes the Python source code from command in the __main__ module. If __main__ does not already exist, it is created. Returns 0 on success or -1 if an exception was raised. If there was an error, it is not possible to get the exception information.

					
int PyRun_SimpleFile(FILE *fp, char *filename)

				

Similar to PyRun_SimpleString(), but the Python source code is read from fp instead of an in-memory string. filename should be the name of the file.

					
int PyRun_InteractiveOne(FILE *fp, char *filename)

int PyRun_InteractiveLoop(FILE *fp, char *filename)

struct _node* PyParser_SimpleParseString(char *str, int start)

				

Parses Python source code from str using the start token start. The result can be used to create a code object that can be evaluated efficiently. This is useful if a code fragment must be evaluated many times.

					
struct _node* PyParser_SimpleParseFile(FILE *fp, char *filename,
int start)

				

Similar to PyParser_SimpleParseString(), but the Python source code is read from fp instead of an in-memory string. filename should be the name of the file.

					
PyObject* PyRun_String(char *str, int start, PyObject *globals,
PyObject *locals)

				

Executes Python source code from str in the context specified by the globals and locals dictionaries. 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 NULL if an exception was raised.

					
PyObject* PyRun_File(FILE *fp, char *filename, int start, PyObject
*globals, PyObject *locals)

				

Similar to PyRun_String(), but the Python source code is read from fp instead of an in-memory string. filename should be the name of the file.

					
PyObject* Py_CompileString(char *str, char *filename, int start)

				

Returns value: New reference. Parses and compiles 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 that can be compiled and should be Py_eval_input, Py_file_input, or Py_single_input. The filename specified by filename is used to construct the code object and can appear in tracebacks or SyntaxError exception messages. This returns NULL if the code cannot be parsed or compiled.

					
int Py_eval_input

				

The start symbol from the Python grammar for isolated expressions; for use with Py_CompileString().

					
int Py_file_input

				

The start symbol from the Python grammar for sequences of statements as read from a file or other source; for use with Py_CompileString(). This is the symbol to use when compiling arbitrarily long Python source code.

					
int Py_single_input

				

The start symbol from the Python grammar for a single statement; for use with Py_CompileString(). This is the symbol used for the interactive interpreter loop.


Last updated on 1/30/2002
Python Developer's Handbook, © 2002 Sams Publishing

< BACKMake Note | BookmarkCONTINUE >

Index terms contained in this section

Application Programmers Interface (API)
     Python/C
            executing source code, files and buffers
buffers
      executing source code, Python/C Application Programmers Interface (API)
code
     source
            executing, Python/C Application Programmers Interface (API)
files
     executing source code, Application Programmers Interface (API)
            Python/C
functions
     executing source code, Application Programmers Interface (API)
            Python/C
interfaces
     Python/C Application Programmers (API)
            executing source code, files and buffers
Python/C Application Programmers Interface (API)
      executing source code, files and buffers
source code
      executing, Python/C Application Programmers (API)

© 2002, O'Reilly & Associates, Inc.