summaryrefslogtreecommitdiffstats
path: root/Include/cpython/pystate.h
diff options
context:
space:
mode:
authorVictor Stinner <vstinner@python.org>2022-06-17 14:12:00 (GMT)
committerGitHub <noreply@github.com>2022-06-17 14:12:00 (GMT)
commit0ff626f210c69643d0d5afad1e6ec6511272b3ce (patch)
treecc6b273fa241aeaccbcfa1ecff5bb6793f746e84 /Include/cpython/pystate.h
parentf64557f4803528c53bb9a1d565e3cdf92e97152f (diff)
downloadcpython-0ff626f210c69643d0d5afad1e6ec6511272b3ce.zip
cpython-0ff626f210c69643d0d5afad1e6ec6511272b3ce.tar.gz
cpython-0ff626f210c69643d0d5afad1e6ec6511272b3ce.tar.bz2
gh-77782: Deprecate global configuration variable (#93943)
Deprecate global configuration variable like Py_IgnoreEnvironmentFlag: the Py_InitializeFromConfig() API should be instead. Fix declaration of Py_GETENV(): use PyAPI_FUNC(), not PyAPI_DATA().
Diffstat (limited to 'Include/cpython/pystate.h')
-rw-r--r--Include/cpython/pystate.h5
1 files changed, 4 insertions, 1 deletions
diff --git a/Include/cpython/pystate.h b/Include/cpython/pystate.h
index 2bd4606..cc3c3ea 100644
--- a/Include/cpython/pystate.h
+++ b/Include/cpython/pystate.h
@@ -279,7 +279,10 @@ PyAPI_FUNC(const PyConfig*) _PyInterpreterState_GetConfig(PyInterpreterState *in
for example.
Python must be preinitialized to call this method.
- The caller must hold the GIL. */
+ The caller must hold the GIL.
+
+ Once done with the configuration, PyConfig_Clear() must be called to clear
+ it. */
PyAPI_FUNC(int) _PyInterpreterState_GetConfigCopy(
struct PyConfig *config);