mirror of
				https://github.com/python/cpython.git
				synced 2025-10-31 02:15:10 +00:00 
			
		
		
		
	Add documentation for Py_Main() and PyThreadState_GetDict().
This commit is contained in:
		
							parent
							
								
									fc43d00c17
								
							
						
					
					
						commit
						24e621918b
					
				
					 1 changed files with 21 additions and 0 deletions
				
			
		|  | @ -609,6 +609,19 @@ so care should be taken that \ctype{FILE*} parameters are only passed | ||||||
| to these functions if it is certain that they were created by the same | to these functions if it is certain that they were created by the same | ||||||
| library that the Python runtime is using. | library that the Python runtime is using. | ||||||
| 
 | 
 | ||||||
|  | \begin{cfuncdesc}{int}{Py_Main}{int argc, char **argv} | ||||||
|  |   The main program for the standard interpreter.  This is made | ||||||
|  |   available for programs which embed Python.  The \var{argc} and | ||||||
|  |   \var{argv} parameters should be prepared exactly as those which are | ||||||
|  |   passed to a C program's \cfunction{main()} function.  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 the integer passed to the | ||||||
|  |   \function{sys.exit()} function, \code{1} if the interpreter exits | ||||||
|  |   due to an exception, or \code{2} if the parameter list does not | ||||||
|  |   represent a valid Python command line. | ||||||
|  | \end{cfuncdesc} | ||||||
|  | 
 | ||||||
| \begin{cfuncdesc}{int}{PyRun_AnyFile}{FILE *fp, char *filename} | \begin{cfuncdesc}{int}{PyRun_AnyFile}{FILE *fp, char *filename} | ||||||
|   If \var{fp} refers to a file associated with an interactive device |   If \var{fp} refers to a file associated with an interactive device | ||||||
|   (console or terminal input or \UNIX{} pseudo-terminal), return the |   (console or terminal input or \UNIX{} pseudo-terminal), return the | ||||||
|  | @ -4631,6 +4644,14 @@ argument \var{tstate}, which may be \NULL{}.  The interpreter lock | ||||||
| must be held. | must be held. | ||||||
| \end{cfuncdesc} | \end{cfuncdesc} | ||||||
| 
 | 
 | ||||||
|  | \begin{cfuncdesc}{PyObject*}{PyThreadState_GetDict}{} | ||||||
|  | Return a dictionary in which extensions can store thread-specific | ||||||
|  | state information.  Each extension should use a unique key to use to | ||||||
|  | store state in the dictionary.  If this function returns \NULL, an | ||||||
|  | exception has been raised and the caller should allow it to | ||||||
|  | propogate. | ||||||
|  | \end{cfuncdesc} | ||||||
|  | 
 | ||||||
| 
 | 
 | ||||||
| \chapter{Memory Management \label{memory}} | \chapter{Memory Management \label{memory}} | ||||||
| \sectionauthor{Vladimir Marangozov}{Vladimir.Marangozov@inrialpes.fr} | \sectionauthor{Vladimir Marangozov}{Vladimir.Marangozov@inrialpes.fr} | ||||||
|  |  | ||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue
	
	 Fred Drake
						Fred Drake