The Very High Level Layer — Python 3.15.2 documentation
Navigation index modules | next | previous | Python » 3.15.2 documentation » Python/C API ਹਵਾਲਾ ਦਸਤਾਵੇਜ਼ » The Very High Level Layer | Theme | 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 Py_eval_input , Py_file_input , Py_single_input , and Py_func_type_input . 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. int PyRun_AnyFile ( FILE * fp , const char * filename ) ¶ This is a simplified interface to PyRun_AnyFileExFlags() below, leaving closeit set to 0 and flags set to NULL . int PyRun_AnyFileFlags ( FILE * fp , const char * filename , PyCompilerFlags * flags ) ¶ This is a simplified interface to PyRun_AnyFileExFlags() below, leaving the closeit argument set to 0 . int PyRun_AnyFileEx ( FILE * fp , const char * filename , int closeit ) ¶ This is a simplified interface to PyRun_AnyFileExFlags() below, leaving the flags argument set to NULL . int PyRun_AnyFileExFlags ( FILE * fp , const char * filename , int closeit , PyCompilerFlags * flags ) ¶ If fp refers to a file associated with an interactive device (console or terminal input or Unix pseudo-terminal), return the value of PyRun_InteractiveLoop() , otherwise return the result of PyRun_SimpleFile() . filename is decoded from the filesystem encoding ( sys.getfilesystemencoding() ).
If filename is NULL , this function uses "???" as the filename. If closeit is true, the file is closed before PyRun_SimpleFileExFlags() returns. int PyRun_SimpleString ( const char * command ) ¶ This is a simplified interface to PyRun_SimpleStringFlags() below, leaving the PyCompilerFlags * argument set to NULL . int PyRun_SimpleStringFlags ( const char * command , PyCompilerFlags * flags ) ¶ Executes the Python source code from command in the __main__ module according to the flags argument.
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, there is no way to get the exception information. For the meaning of flags , see below. Note that if an otherwise unhandled SystemExit is raised, this function will not return -1 , but exit the process, as long as PyConfig.inspect is zero. int PyRun_SimpleFile ( FILE * fp , const char * filename ) ¶ This is a simplified interface to PyRun_SimpleFileExFlags() below, leaving closeit set to 0 and flags set to NULL . int PyRun_SimpleFileEx ( FILE * fp , const char * filename , int closeit ) ¶ This is a simplified interface to PyRun_SimpleFileExFlags() below, leaving flags set to NULL . int PyRun_SimpleFileExFlags ( FILE * fp , const char * filename , int closeit , PyCompilerFlags * flags ) ¶ Similar to PyRun_SimpleStringFlags() , 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 filesystem encoding and error handler .
If closeit is true, the file is closed before PyRun_SimpleFileExFlags() returns. Note On Windows, fp should be opened as binary mode (e.g. fopen(filename, "rb") ). Otherwise, Python may not handle script file with LF line ending correctly. int PyRun_InteractiveOneObject ( FILE * fp , PyObject * filename , PyCompilerFlags * flags ) ¶ 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 sys.ps1 and sys.ps2 . filename must be a Python str object. Returns 0 when the input was executed successfully, -1 if there was an exception, or an error code from the errcode.h include file distributed as part of Python if there was a parse error. (Note that errcode.h is not included by Python.h , so must be included specifically if needed.) int PyRun_InteractiveOne ( FILE * fp , const char * filename ) ¶ This is a simplified interface to PyRun_InteractiveOneFlags() below, leaving flags set to NULL . int PyRun_InteractiveOneFlags ( FILE * fp , const char * filename , PyCompilerFlags * flags ) ¶ Similar to PyRun_InteractiveOneObject() , but filename is a const char * , which is decoded from the filesystem encoding and error handler . int PyRun_InteractiveLoop ( FILE * fp , const char * filename ) ¶ This is a simplified interface to PyRun_InteractiveLoopFlags() below, leaving flags set to NULL . int PyRun_InteractiveLoopFlags ( FILE * fp , const char * filename , PyCompilerFlags * flags ) ¶ Read and execute statements from a file associated with an interactive device until EOF is reached.
The user will be prompted using sys.ps1 and sys.ps2 . filename is decoded from the filesystem encoding and error handler . Returns 0 at EOF or a negative number upon failure. int ( * PyOS_InputHook ) ( void ) ¶ Part of the Stable ABI . 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 Modules/_tkinter.c in the Python source code. The function is called without an attached thread state . Changed in version 3.12: This function is only called from the main interpreter . char * ( * PyOS_ReadlineFunctionPointer ) ( FILE * , FILE * , const char * ) ¶ Can be set to point to a function with the prototype char *func(FILE *stdin, FILE *stdout, const 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 readline module sets this hook to provide line-editing and tab-completion features. The function is called without an attached thread state . If this pointer is NULL , PyOS_Readline() sets it to the default implementation, PyOS_Readline() , before reading input.
The returned string must be null-terminated and include the trailing newline, if one was read. Return an empty string if the end of the file is reached before any characters are read. Return NULL on failure or interruption; a Python exception may be set. A non- NULL result must be a string allocated by PyMem_RawMalloc() or PyMem_RawRealloc() . Changed in version 3.4: The result must be allocated by PyMem_RawMalloc() or PyMem_RawRealloc() , instead of being allocated by PyMem_Malloc() or PyMem_Realloc() .
Changed in version 3.12: This function is only called from the main interpreter . char * PyOS_Readline ( FILE * sys_stdin , FILE * sys_stdout , const char * prompt ) ¶ Display prompt , if it is not NULL , and read a line from sys_stdin . If both streams are terminals and the call is made from the main interpreter , use PyOS_ReadlineFunctionPointer . Otherwise, use the default implementation, which flushes sys_stdout and writes prompt to the C standard error stream.
The returned string follows the contract of PyOS_ReadlineFunctionPointer , but the caller must free it with PyMem_Free() . Return NULL on failure or interruption; a Python exception may be set. PyObject * PyRun_String ( const char * str , int start , PyObject * globals , PyObject * locals )
The rest of this page is on the live site.