Merge remote-tracking branch 'upstream/main' into cleanup/315/depreca…

…ted-globals-133644
picnixz · May 8, 2025 · May 8, 2025 · May 8, 2025 · May 8, 2025 · May 8, 2025
commit b8afe23cff5c7b0fa1b9eba869eb77b34755aedb
@@ -167,29 +167,67 @@ Deprecated C APIs
 Removed C APIs
 --------------
 
+* :c:func:`!PyImport_ImportModuleNoBlock`: deprecated alias
+  of :c:func:`PyImport_ImportModule`.
+
+The following functions are removed in favor of :c:func:`PyConfig_Get`.
+The |pythoncapi_compat_project| can be used to get :c:func:`!PyConfig_Get`
+on Python 3.13 and older.
+
+* Python initialization functions:
+
+  * :c:func:`!Py_GetExecPrefix`:
+    use :c:func:`PyConfig_Get("base_exec_prefix") <PyConfig_Get>`
+    (:data:`sys.base_exec_prefix`) instead.
+    Use :c:func:`PyConfig_Get("exec_prefix") <PyConfig_Get>`
+    (:data:`sys.exec_prefix`) if :ref:`virtual environments <venv-def>`
+    need to be handled.
+  * :c:func:`!Py_GetPath`:
+    use :c:func:`PyConfig_Get("module_search_paths") <PyConfig_Get>`
+    (:data:`sys.path`) instead.
+  * :c:func:`!Py_GetPrefix`:
+    use :c:func:`PyConfig_Get("base_prefix") <PyConfig_Get>`
+    (:data:`sys.base_prefix`) instead.
+    Use :c:func:`PyConfig_Get("prefix") <PyConfig_Get>`
+    (:data:`sys.prefix`) if :ref:`virtual environments <venv-def>`
+    need to be handled.
+  * :c:func:`!Py_GetProgramFullPath`:
+    use :c:func:`PyConfig_Get("executable") <PyConfig_Get>`
+    (:data:`sys.executable`) instead.
+  * :c:func:`!Py_GetProgramName`:
+    use :c:func:`PyConfig_Get("executable") <PyConfig_Get>`
+    (:data:`sys.executable`) instead.
+  * :c:func:`!Py_GetPythonHome`:
+    use :c:func:`PyConfig_Get("home") <PyConfig_Get>` or the
+    :envvar:`PYTHONHOME` environment variable instead.
+
+.. |pythoncapi_compat_project| replace:: |pythoncapi_compat_project_link|_
+.. |pythoncapi_compat_project_link| replace:: pythoncapi-compat project
+.. _pythoncapi_compat_project_link: https://github.com/python/pythoncapi-compat
+
 * Global configuration variables:
 
-  * :c:var:`!Py_BytesWarningFlag`: use :c:member:`PyConfig.bytes_warning`
-  * :c:var:`!Py_DebugFlag`: use :c:member:`PyConfig.parser_debug`
-  * :c:var:`!Py_DontWriteBytecodeFlag`: use :c:member:`PyConfig.write_bytecode`
-  * :c:var:`!Py_FileSystemDefaultEncodeErrors`: use :c:member:`PyConfig.filesystem_errors`
-  * :c:var:`!Py_FileSystemDefaultEncoding`: use :c:member:`PyConfig.filesystem_encoding`
-  * :c:var:`!Py_FrozenFlag`: use :c:member:`PyConfig.pathconfig_warnings`
-  * :c:var:`!Py_HasFileSystemDefaultEncoding`: use :c:member:`PyConfig.filesystem_encoding`
+  * :c:var:`!Py_BytesWarningFlag`: use :c:member:`PyConfig.bytes_warning`.
+  * :c:var:`!Py_DebugFlag`: use :c:member:`PyConfig.parser_debug`.
+  * :c:var:`!Py_DontWriteBytecodeFlag`: use :c:member:`PyConfig.write_bytecode`.
+  * :c:var:`!Py_FileSystemDefaultEncodeErrors`: use :c:member:`PyConfig.filesystem_errors`.
+  * :c:var:`!Py_FileSystemDefaultEncoding`: use :c:member:`PyConfig.filesystem_encoding`.
+  * :c:var:`!Py_FrozenFlag`: use :c:member:`PyConfig.pathconfig_warnings`.
+  * :c:var:`!Py_HasFileSystemDefaultEncoding`: use :c:member:`PyConfig.filesystem_encoding`.
   * :c:var:`!Py_HashRandomizationFlag`: use :c:member:`PyConfig.use_hash_seed`
-    and :c:member:`PyConfig.hash_seed`
-  * :c:var:`!Py_IgnoreEnvironmentFlag`: use :c:member:`PyConfig.use_environment`
-  * :c:var:`!Py_InspectFlag`: use :c:member:`PyConfig.inspect`
-  * :c:var:`!Py_IsolatedFlag`: use :c:member:`PyConfig.isolated`
-  * :c:var:`!Py_NoSiteFlag`: use :c:member:`PyConfig.site_import`
-  * :c:var:`!Py_NoUserSiteDirectory`: use :c:member:`PyConfig.user_site_directory`
-  * :c:var:`!Py_OptimizeFlag`: use :c:member:`PyConfig.optimization_level`
-  * :c:var:`!Py_QuietFlag`: use :c:member:`PyConfig.quiet`
-  * :c:var:`!Py_UnbufferedStdioFlag`: use :c:member:`PyConfig.buffered_stdio`
-  * :c:var:`!Py_VerboseFlag`: use :c:member:`PyConfig.verbose`
+    and :c:member:`PyConfig.hash_seed`.
+  * :c:var:`!Py_IgnoreEnvironmentFlag`: use :c:member:`PyConfig.use_environment`.
+  * :c:var:`!Py_InspectFlag`: use :c:member:`PyConfig.inspect`.
+  * :c:var:`!Py_IsolatedFlag`: use :c:member:`PyConfig.isolated`.
+  * :c:var:`!Py_NoSiteFlag`: use :c:member:`PyConfig.site_import`.
+  * :c:var:`!Py_NoUserSiteDirectory`: use :c:member:`PyConfig.user_site_directory`.
+  * :c:var:`!Py_OptimizeFlag`: use :c:member:`PyConfig.optimization_level`.
+  * :c:var:`!Py_QuietFlag`: use :c:member:`PyConfig.quiet`.
+  * :c:var:`!Py_UnbufferedStdioFlag`: use :c:member:`PyConfig.buffered_stdio`.
+  * :c:var:`!Py_VerboseFlag`: use :c:member:`PyConfig.verbose`.
 
 * Windows-only global configuration variables:
 
-  * :c:var:`!Py_LegacyWindowsFSEncodingFlag`: use :c:member:`PyPreConfig.legacy_windows_fs_encoding`
-  * :c:var:`!Py_LegacyWindowsStdioFlag`: use :c:member:`PyConfig.legacy_windows_stdio`
+  * :c:var:`!Py_LegacyWindowsFSEncodingFlag`: use :c:member:`PyPreConfig.legacy_windows_fs_encoding`.
+  * :c:var:`!Py_LegacyWindowsStdioFlag`: use :c:member:`PyConfig.legacy_windows_stdio`.