blob: ca1f24f2a17463ab9ed772babd3659f535a22e04 [file] [log] [blame]
Nick Coghland6009512014-11-20 21:39:37 +10001
2/* Interfaces to configure, query, create & destroy the Python runtime */
3
4#ifndef Py_PYLIFECYCLE_H
5#define Py_PYLIFECYCLE_H
6#ifdef __cplusplus
7extern "C" {
8#endif
9
Serhiy Storchaka4ae06c52017-12-12 13:55:04 +020010PyAPI_FUNC(void) Py_SetProgramName(const wchar_t *);
Victor Stinner0327bde2017-11-23 17:03:20 +010011PyAPI_FUNC(wchar_t *) Py_GetProgramName(void);
12
Serhiy Storchaka4ae06c52017-12-12 13:55:04 +020013PyAPI_FUNC(void) Py_SetPythonHome(const wchar_t *);
Victor Stinner0327bde2017-11-23 17:03:20 +010014PyAPI_FUNC(wchar_t *) Py_GetPythonHome(void);
Victor Stinner0327bde2017-11-23 17:03:20 +010015
16#ifndef Py_LIMITED_API
17/* Only used by applications that embed the interpreter and need to
18 * override the standard encoding determination mechanism
19 */
20PyAPI_FUNC(int) Py_SetStandardStreamEncoding(const char *encoding,
21 const char *errors);
Victor Stinner124b9eb2018-08-29 01:29:06 +020022#endif
Victor Stinner0327bde2017-11-23 17:03:20 +010023
Victor Stinner124b9eb2018-08-29 01:29:06 +020024
25#ifndef Py_LIMITED_API
Eric Snow1abcf672017-05-23 21:46:51 -070026/* PEP 432 Multi-phase initialization API (Private while provisional!) */
Victor Stinner1dc6e392018-07-25 02:49:17 +020027PyAPI_FUNC(_PyInitError) _Py_InitializeCore(
28 PyInterpreterState **interp,
29 const _PyCoreConfig *);
Eric Snow1abcf672017-05-23 21:46:51 -070030PyAPI_FUNC(int) _Py_IsCoreInitialized(void);
Victor Stinner46972b72017-11-24 22:55:40 +010031
Victor Stinnerb5fd9ad2017-12-14 02:20:52 +010032
Victor Stinnerc4bca952017-12-19 23:48:17 +010033PyAPI_FUNC(_PyInitError) _PyMainInterpreterConfig_Read(
34 _PyMainInterpreterConfig *config,
35 const _PyCoreConfig *core_config);
Victor Stinner46972b72017-11-24 22:55:40 +010036PyAPI_FUNC(void) _PyMainInterpreterConfig_Clear(_PyMainInterpreterConfig *);
Victor Stinnerda273412017-12-15 01:46:02 +010037PyAPI_FUNC(int) _PyMainInterpreterConfig_Copy(
38 _PyMainInterpreterConfig *config,
39 const _PyMainInterpreterConfig *config2);
Victor Stinner46972b72017-11-24 22:55:40 +010040
Victor Stinner1dc6e392018-07-25 02:49:17 +020041PyAPI_FUNC(_PyInitError) _Py_InitializeMainInterpreter(
42 PyInterpreterState *interp,
43 const _PyMainInterpreterConfig *);
Nick Coghland6009512014-11-20 21:39:37 +100044#endif
45
Eric Snow1abcf672017-05-23 21:46:51 -070046/* Initialization and finalization */
Nick Coghland6009512014-11-20 21:39:37 +100047PyAPI_FUNC(void) Py_Initialize(void);
48PyAPI_FUNC(void) Py_InitializeEx(int);
49#ifndef Py_LIMITED_API
Victor Stinner1dc6e392018-07-25 02:49:17 +020050PyAPI_FUNC(_PyInitError) _Py_InitializeFromConfig(
51 const _PyCoreConfig *config);
Victor Stinnercfc88312018-08-01 16:41:25 +020052PyAPI_FUNC(void) _Py_NO_RETURN _Py_FatalInitError(_PyInitError err);
Nick Coghland6009512014-11-20 21:39:37 +100053#endif
54PyAPI_FUNC(void) Py_Finalize(void);
Martin Panterb4ce1fc2015-11-30 03:18:29 +000055PyAPI_FUNC(int) Py_FinalizeEx(void);
Nick Coghland6009512014-11-20 21:39:37 +100056PyAPI_FUNC(int) Py_IsInitialized(void);
Eric Snow1abcf672017-05-23 21:46:51 -070057
58/* Subinterpreter support */
Nick Coghland6009512014-11-20 21:39:37 +100059PyAPI_FUNC(PyThreadState *) Py_NewInterpreter(void);
60PyAPI_FUNC(void) Py_EndInterpreter(PyThreadState *);
61
62
63/* Py_PyAtExit is for the atexit module, Py_AtExit is for low-level
64 * exit functions.
65 */
66#ifndef Py_LIMITED_API
Marcel Plch776407f2017-12-20 11:17:58 +010067PyAPI_FUNC(void) _Py_PyAtExit(void (*func)(PyObject *), PyObject *);
Nick Coghland6009512014-11-20 21:39:37 +100068#endif
69PyAPI_FUNC(int) Py_AtExit(void (*func)(void));
70
Victor Stinnercfc88312018-08-01 16:41:25 +020071PyAPI_FUNC(void) _Py_NO_RETURN Py_Exit(int);
Nick Coghland6009512014-11-20 21:39:37 +100072
73/* Restore signals that the interpreter has called SIG_IGN on to SIG_DFL. */
74#ifndef Py_LIMITED_API
75PyAPI_FUNC(void) _Py_RestoreSignals(void);
76
77PyAPI_FUNC(int) Py_FdIsInteractive(FILE *, const char *);
78#endif
79
80/* Bootstrap __main__ (defined in Modules/main.c) */
81PyAPI_FUNC(int) Py_Main(int argc, wchar_t **argv);
82
83/* In getpath.c */
84PyAPI_FUNC(wchar_t *) Py_GetProgramFullPath(void);
85PyAPI_FUNC(wchar_t *) Py_GetPrefix(void);
86PyAPI_FUNC(wchar_t *) Py_GetExecPrefix(void);
87PyAPI_FUNC(wchar_t *) Py_GetPath(void);
88PyAPI_FUNC(void) Py_SetPath(const wchar_t *);
89#ifdef MS_WINDOWS
Victor Stinner31a83932017-12-04 13:39:15 +010090int _Py_CheckPython3(void);
Nick Coghland6009512014-11-20 21:39:37 +100091#endif
92
93/* In their own files */
94PyAPI_FUNC(const char *) Py_GetVersion(void);
95PyAPI_FUNC(const char *) Py_GetPlatform(void);
96PyAPI_FUNC(const char *) Py_GetCopyright(void);
97PyAPI_FUNC(const char *) Py_GetCompiler(void);
98PyAPI_FUNC(const char *) Py_GetBuildInfo(void);
99#ifndef Py_LIMITED_API
Ned Deily5c4b0d02017-03-04 00:19:55 -0500100PyAPI_FUNC(const char *) _Py_gitidentifier(void);
101PyAPI_FUNC(const char *) _Py_gitversion(void);
Nick Coghland6009512014-11-20 21:39:37 +1000102#endif
103
104/* Internal -- various one-time initializations */
105#ifndef Py_LIMITED_API
106PyAPI_FUNC(PyObject *) _PyBuiltin_Init(void);
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800107PyAPI_FUNC(_PyInitError) _PySys_BeginInit(PyObject **sysmod);
Victor Stinnerfbca9082018-08-30 00:50:45 +0200108PyAPI_FUNC(int) _PySys_EndInit(PyObject *sysdict, PyInterpreterState *interp);
Victor Stinner672b6ba2017-12-06 17:25:50 +0100109PyAPI_FUNC(_PyInitError) _PyImport_Init(PyInterpreterState *interp);
Nick Coghland6009512014-11-20 21:39:37 +1000110PyAPI_FUNC(void) _PyExc_Init(PyObject * bltinmod);
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800111PyAPI_FUNC(_PyInitError) _PyImportHooks_Init(void);
Nick Coghland6009512014-11-20 21:39:37 +1000112PyAPI_FUNC(int) _PyFloat_Init(void);
113PyAPI_FUNC(int) PyByteArray_Init(void);
Victor Stinner358e5e12017-12-15 00:51:22 +0100114PyAPI_FUNC(_PyInitError) _Py_HashRandomization_Init(const _PyCoreConfig *);
115#endif
Nick Coghland6009512014-11-20 21:39:37 +1000116
117/* Various internal finalizers */
Victor Stinner92a3c6f2017-12-06 18:12:59 +0100118
Victor Stinner92a3c6f2017-12-06 18:12:59 +0100119#ifndef Py_LIMITED_API
Nick Coghland6009512014-11-20 21:39:37 +1000120PyAPI_FUNC(void) PyMethod_Fini(void);
121PyAPI_FUNC(void) PyFrame_Fini(void);
122PyAPI_FUNC(void) PyCFunction_Fini(void);
123PyAPI_FUNC(void) PyDict_Fini(void);
124PyAPI_FUNC(void) PyTuple_Fini(void);
125PyAPI_FUNC(void) PyList_Fini(void);
126PyAPI_FUNC(void) PySet_Fini(void);
127PyAPI_FUNC(void) PyBytes_Fini(void);
128PyAPI_FUNC(void) PyByteArray_Fini(void);
129PyAPI_FUNC(void) PyFloat_Fini(void);
130PyAPI_FUNC(void) PyOS_FiniInterrupts(void);
Nick Coghland6009512014-11-20 21:39:37 +1000131PyAPI_FUNC(void) PySlice_Fini(void);
Yury Selivanoveb636452016-09-08 22:01:51 -0700132PyAPI_FUNC(void) PyAsyncGen_Fini(void);
Nick Coghland6009512014-11-20 21:39:37 +1000133
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600134PyAPI_FUNC(int) _Py_IsFinalizing(void);
Victor Stinner92a3c6f2017-12-06 18:12:59 +0100135#endif /* !Py_LIMITED_API */
Nick Coghland6009512014-11-20 21:39:37 +1000136
137/* Signals */
138typedef void (*PyOS_sighandler_t)(int);
139PyAPI_FUNC(PyOS_sighandler_t) PyOS_getsig(int);
140PyAPI_FUNC(PyOS_sighandler_t) PyOS_setsig(int, PyOS_sighandler_t);
141
Serhiy Storchaka9fab79b2016-09-11 11:03:14 +0300142#ifndef Py_LIMITED_API
Nick Coghland6009512014-11-20 21:39:37 +1000143/* Random */
Victor Stinnere66987e2016-09-06 16:33:52 -0700144PyAPI_FUNC(int) _PyOS_URandom(void *buffer, Py_ssize_t size);
145PyAPI_FUNC(int) _PyOS_URandomNonblock(void *buffer, Py_ssize_t size);
Serhiy Storchaka9fab79b2016-09-11 11:03:14 +0300146#endif /* !Py_LIMITED_API */
Nick Coghland6009512014-11-20 21:39:37 +1000147
Erik Bray031c4bf2017-10-27 11:46:03 +0200148/* Legacy locale support */
149#ifndef Py_LIMITED_API
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200150PyAPI_FUNC(void) _Py_CoerceLegacyLocale(int warn);
Erik Bray031c4bf2017-10-27 11:46:03 +0200151PyAPI_FUNC(int) _Py_LegacyLocaleDetected(void);
xdegaye1588be62017-11-12 12:45:59 +0100152PyAPI_FUNC(char *) _Py_SetLocaleFromEnv(int category);
Erik Bray031c4bf2017-10-27 11:46:03 +0200153#endif
154
Nick Coghland6009512014-11-20 21:39:37 +1000155#ifdef __cplusplus
156}
157#endif
158#endif /* !Py_PYLIFECYCLE_H */