Rooba
/
cpython
mirror of https://github.com/python/cpython.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
cpython/Include/pylifecycle.h

81 lines
2.4 KiB
C
Raw Normal View History

Issue #22869: Split pythonrun into two modules - interpreter startup and shutdown code moved to a new pylifecycle.c module - Py_OptimizeFlag moved into the new module with the other global flags
2014-11-20 11:39:37 +00:00
/* Interfaces to configure, query, create & destroy the Python runtime */
#ifndef Py_PYLIFECYCLE_H
#define Py_PYLIFECYCLE_H
#ifdef __cplusplus
extern "C" {
#endif
bpo-22257: Private C-API for core runtime initialization (PEP 432). (#1772) (patch by Nick Coghlan)
2017-05-24 04:46:51 +00:00
/* Initialization and finalization */
Issue #22869: Split pythonrun into two modules - interpreter startup and shutdown code moved to a new pylifecycle.c module - Py_OptimizeFlag moved into the new module with the other global flags
2014-11-20 11:39:37 +00:00
PyAPI_FUNC(void) Py_Initialize(void);
PyAPI_FUNC(void) Py_InitializeEx(int);
PyAPI_FUNC(void) Py_Finalize(void);
bpo-35259: Limit `Py_FinalizeEx()` to `Py_LIMITED_API >= 0x03060000`. (GH-10620)
2018-12-20 21:11:03 +00:00
#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03060000
Issue #5319: New Py_FinalizeEx() API to exit with status 120 on failure
2015-11-30 03:18:29 +00:00
PyAPI_FUNC(int) Py_FinalizeEx(void);
bpo-35259: Limit `Py_FinalizeEx()` to `Py_LIMITED_API >= 0x03060000`. (GH-10620)
2018-12-20 21:11:03 +00:00
#endif
Issue #22869: Split pythonrun into two modules - interpreter startup and shutdown code moved to a new pylifecycle.c module - Py_OptimizeFlag moved into the new module with the other global flags
2014-11-20 11:39:37 +00:00
PyAPI_FUNC(int) Py_IsInitialized(void);
bpo-22257: Private C-API for core runtime initialization (PEP 432). (#1772) (patch by Nick Coghlan)
2017-05-24 04:46:51 +00:00
/* Subinterpreter support */
Issue #22869: Split pythonrun into two modules - interpreter startup and shutdown code moved to a new pylifecycle.c module - Py_OptimizeFlag moved into the new module with the other global flags
2014-11-20 11:39:37 +00:00
PyAPI_FUNC(PyThreadState *) Py_NewInterpreter(void);
PyAPI_FUNC(void) Py_EndInterpreter(PyThreadState *);
/* Py_PyAtExit is for the atexit module, Py_AtExit is for low-level
* exit functions.
*/
PyAPI_FUNC(int) Py_AtExit(void (*func)(void));
Define _Py_NO_RETURN for Microsoft C compiler (GH-8606)
2018-08-01 14:41:25 +00:00
PyAPI_FUNC(void) _Py_NO_RETURN Py_Exit(int);
Issue #22869: Split pythonrun into two modules - interpreter startup and shutdown code moved to a new pylifecycle.c module - Py_OptimizeFlag moved into the new module with the other global flags
2014-11-20 11:39:37 +00:00
/* Bootstrap __main__ (defined in Modules/main.c) */
PyAPI_FUNC(int) Py_Main(int argc, wchar_t **argv);
bpo-36763: Make Py_BytesMain() public (GH-15532) Declare Py_BytesMain() in Include/pylifecycle.h, rather in Include/internal/pycore_pylifecycle.h.
2019-08-26 22:45:45 +00:00
PyAPI_FUNC(int) Py_BytesMain(int argc, char **argv);
bpo-34725: Adds _Py_SetProgramFullPath so embedders may override sys.executable (GH-9860)
2018-11-18 04:41:48 +00:00
/* In pathconfig.c */
gh-117987: Restore several functions removed in Python 3.13 alpha 1 (GH-117993) Restore these functions removed in Python 3.13 alpha 1: * Py_SetPythonHome() * Py_SetProgramName() * PySys_SetArgvEx() * PySys_SetArgv()
2024-04-18 13:20:38 +00:00
Py_DEPRECATED(3.11) PyAPI_FUNC(void) Py_SetProgramName(const wchar_t *);
gh-105145: Deprecate Py_GetPath() function (#105179) Deprecate old Python initialization functions: * PySys_ResetWarnOptions() * Py_GetExecPrefix() * Py_GetPath() * Py_GetPrefix() * Py_GetProgramFullPath() * Py_GetProgramName() * Py_GetPythonHome() _tkinter.c uses sys.executable instead of Py_GetProgramName() and uses sys.prefix instead of Py_GetPrefix().
2023-06-01 12:06:32 +00:00
Py_DEPRECATED(3.13) PyAPI_FUNC(wchar_t *) Py_GetProgramName(void);
gh-117987: Restore several functions removed in Python 3.13 alpha 1 (GH-117993) Restore these functions removed in Python 3.13 alpha 1: * Py_SetPythonHome() * Py_SetProgramName() * PySys_SetArgvEx() * PySys_SetArgv()
2024-04-18 13:20:38 +00:00
Py_DEPRECATED(3.11) PyAPI_FUNC(void) Py_SetPythonHome(const wchar_t *);
gh-105145: Deprecate Py_GetPath() function (#105179) Deprecate old Python initialization functions: * PySys_ResetWarnOptions() * Py_GetExecPrefix() * Py_GetPath() * Py_GetPrefix() * Py_GetProgramFullPath() * Py_GetProgramName() * Py_GetPythonHome() _tkinter.c uses sys.executable instead of Py_GetProgramName() and uses sys.prefix instead of Py_GetPrefix().
2023-06-01 12:06:32 +00:00
Py_DEPRECATED(3.13) PyAPI_FUNC(wchar_t *) Py_GetPythonHome(void);
gh-117987: Restore several functions removed in Python 3.13 alpha 1 (GH-117993) Restore these functions removed in Python 3.13 alpha 1: * Py_SetPythonHome() * Py_SetProgramName() * PySys_SetArgvEx() * PySys_SetArgv()
2024-04-18 13:20:38 +00:00
gh-105145: Deprecate Py_GetPath() function (#105179) Deprecate old Python initialization functions: * PySys_ResetWarnOptions() * Py_GetExecPrefix() * Py_GetPath() * Py_GetPrefix() * Py_GetProgramFullPath() * Py_GetProgramName() * Py_GetPythonHome() _tkinter.c uses sys.executable instead of Py_GetProgramName() and uses sys.prefix instead of Py_GetPrefix().
2023-06-01 12:06:32 +00:00
Py_DEPRECATED(3.13) PyAPI_FUNC(wchar_t *) Py_GetProgramFullPath(void);
Py_DEPRECATED(3.13) PyAPI_FUNC(wchar_t *) Py_GetPrefix(void);
Py_DEPRECATED(3.13) PyAPI_FUNC(wchar_t *) Py_GetExecPrefix(void);
Py_DEPRECATED(3.13) PyAPI_FUNC(wchar_t *) Py_GetPath(void);
Issue #22869: Split pythonrun into two modules - interpreter startup and shutdown code moved to a new pylifecycle.c module - Py_OptimizeFlag moved into the new module with the other global flags
2014-11-20 11:39:37 +00:00
#ifdef MS_WINDOWS
Revert "bpo-32197: Try to fix a compiler error on OS X introduced in bpo-32030. (#4681)" (#4694) * Revert "bpo-32197: Try to fix a compiler error on OS X introduced in bpo-32030. (#4681)" This reverts commit 13badcbc60cdbfae1dba1683fd2fae9d70717143. Re-apply commits: * "bpo-32030: _PyPathConfig_Init() sets home and program_name (#4673)" commit af5a895073c24637c094772b27526b94a12ec897. * "bpo-32030: Fix config_get_program_name() on macOS (#4669)" commit e23c06e2b03452c9aaf0dae52296c85e572f9bcd. * "bpo-32030: Add Python/pathconfig.c (#4668)" commit 0ea395ae964c9cd0f499e2ef0d0030c971201220. * "bpo-32030: Don't call _PyPathConfig_Fini() in Py_FinalizeEx() (#4667)" commit ebac19dad6263141d5db0a2c923efe049dba99d2. * "bpo-32030: Fix Py_GetPath(): init program_name (#4665)" commit 9ac3d8882712c9675c3d2f9f84af6b5729575cde. * Fix compilation error on macOS
2017-12-04 12:39:15 +00:00
int _Py_CheckPython3(void);
Issue #22869: Split pythonrun into two modules - interpreter startup and shutdown code moved to a new pylifecycle.c module - Py_OptimizeFlag moved into the new module with the other global flags
2014-11-20 11:39:37 +00:00
#endif
/* In their own files */
PyAPI_FUNC(const char *) Py_GetVersion(void);
PyAPI_FUNC(const char *) Py_GetPlatform(void);
PyAPI_FUNC(const char *) Py_GetCopyright(void);
PyAPI_FUNC(const char *) Py_GetCompiler(void);
PyAPI_FUNC(const char *) Py_GetBuildInfo(void);
/* Signals */
typedef void (*PyOS_sighandler_t)(int);
PyAPI_FUNC(PyOS_sighandler_t) PyOS_getsig(int);
PyAPI_FUNC(PyOS_sighandler_t) PyOS_setsig(int, PyOS_sighandler_t);
bpo-43931: Export Python version as API data (GH-25577) When Python is embedded in other applications, it is not easy to determine which version of Python is being used. This change exposes the Python version as part of the API data. Tools like Austin (https://github.com/P403n1x87/austin) can benefit from this data when targeting applications like uWSGI, as the Python version can then be inferred systematically by looking at the exported symbols rather than relying on unreliable pattern matching or other hacks (like remote code execution etc...). Automerge-Triggered-By: GH:pablogsal
2021-12-10 01:52:05 +00:00
#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x030B0000
PyAPI_DATA(const unsigned long) Py_Version;
#endif
gh-110397: Add Py_IsFinalizing() to the stable ABI (#110441)
2023-10-07 15:59:16 +00:00
#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x030D0000
PyAPI_FUNC(int) Py_IsFinalizing(void);
#endif
Issue #26900: Excluded underscored names and other private API from limited API.
2016-09-11 08:03:14 +00:00
#ifndef Py_LIMITED_API
bpo-35134: Create Include/cpython/pylifecycle.h (GH-10731) Move pylifecycle.h code surrounded by "#ifndef Py_LIMITED_API" to a new Include/cpython/pylifecycle.h header file.
2018-11-26 23:12:05 +00:00
# define Py_CPYTHON_PYLIFECYCLE_H
bpo-45434: Remove useless space in includes (GH-28963) Micro-optimize spaces!
2021-10-14 23:50:04 +00:00
# include "cpython/pylifecycle.h"
bpo-35134: Create Include/cpython/pylifecycle.h (GH-10731) Move pylifecycle.h code surrounded by "#ifndef Py_LIMITED_API" to a new Include/cpython/pylifecycle.h header file.
2018-11-26 23:12:05 +00:00
# undef Py_CPYTHON_PYLIFECYCLE_H
bpo-31877: Add _Py_LegacyLocaleDetected and _PyCoerceLegacyLocale to pylifecycle.h (GH-4134) Only declaring these as interns inside the CLI's main C module caused build problems on some platforms (notably Cygwin), so this switches them to a regular underscore prefixed "private" C API declaration.
2017-10-27 09:46:03 +00:00
#endif
Issue #22869: Split pythonrun into two modules - interpreter startup and shutdown code moved to a new pylifecycle.c module - Py_OptimizeFlag moved into the new module with the other global flags
2014-11-20 11:39:37 +00:00
#ifdef __cplusplus
}
#endif
#endif /* !Py_PYLIFECYCLE_H */