Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

GH-109975: Copyedit 3.13 What's New: Copyedit C API deprecations pending removal (#124336)

This commit is contained in:
Adam Turner 2024-09-23 19:40:20 +01:00 committed by GitHub
parent f3b2c36deb
commit e7d465a607
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 114 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
Doc/deprecations/c-api-pending-removal-in-3.14.rst
View File

@ -9,38 +9,64 @@ Pending Removal in Python 3.14
* Functions to configure Python's initialization, deprecated in Python 3.11: * Functions to configure Python's initialization, deprecated in Python 3.11:
* ``PySys_SetArgvEx()``: set :c:member:`PyConfig.argv` instead. * :c:func:`!PySys_SetArgvEx()`:
* ``PySys_SetArgv()``: set :c:member:`PyConfig.argv` instead. Set :c:member:`PyConfig.argv` instead.
* ``Py_SetProgramName()``: set :c:member:`PyConfig.program_name` instead. * :c:func:`!PySys_SetArgv()`:
* ``Py_SetPythonHome()``: set :c:member:`PyConfig.home` instead. Set :c:member:`PyConfig.argv` instead.
* :c:func:`!Py_SetProgramName()`:
Set :c:member:`PyConfig.program_name` instead.
* :c:func:`!Py_SetPythonHome()`:
Set :c:member:`PyConfig.home` instead.
The :c:func:`Py_InitializeFromConfig` API should be used with The :c:func:`Py_InitializeFromConfig` API should be used with
:c:type:`PyConfig` instead. :c:type:`PyConfig` instead.
* Global configuration variables: * Global configuration variables:
* :c:var:`Py_DebugFlag`: use :c:member:`PyConfig.parser_debug` instead. * :c:var:`Py_DebugFlag`:
* :c:var:`Py_VerboseFlag`: use :c:member:`PyConfig.verbose` instead. Use :c:member:`PyConfig.parser_debug` instead.
* :c:var:`Py_QuietFlag`: use :c:member:`PyConfig.quiet` instead. * :c:var:`Py_VerboseFlag`:
* :c:var:`Py_InteractiveFlag`: use :c:member:`PyConfig.interactive` instead. Use :c:member:`PyConfig.verbose` instead.
* :c:var:`Py_InspectFlag`: use :c:member:`PyConfig.inspect` instead. * :c:var:`Py_QuietFlag`:
* :c:var:`Py_OptimizeFlag`: use :c:member:`PyConfig.optimization_level` instead. Use :c:member:`PyConfig.quiet` instead.
* :c:var:`Py_NoSiteFlag`: use :c:member:`PyConfig.site_import` instead. * :c:var:`Py_InteractiveFlag`:
* :c:var:`Py_BytesWarningFlag`: use :c:member:`PyConfig.bytes_warning` instead. Use :c:member:`PyConfig.interactive` instead.
* :c:var:`Py_FrozenFlag`: use :c:member:`PyConfig.pathconfig_warnings` instead. * :c:var:`Py_InspectFlag`:
* :c:var:`Py_IgnoreEnvironmentFlag`: use :c:member:`PyConfig.use_environment` instead. Use :c:member:`PyConfig.inspect` instead.
* :c:var:`Py_DontWriteBytecodeFlag`: use :c:member:`PyConfig.write_bytecode` instead. * :c:var:`Py_OptimizeFlag`:
* :c:var:`Py_NoUserSiteDirectory`: use :c:member:`PyConfig.user_site_directory` instead. Use :c:member:`PyConfig.optimization_level` instead.
* :c:var:`Py_UnbufferedStdioFlag`: use :c:member:`PyConfig.buffered_stdio` instead. * :c:var:`Py_NoSiteFlag`:
* :c:var:`Py_HashRandomizationFlag`: use :c:member:`PyConfig.use_hash_seed` Use :c:member:`PyConfig.site_import` instead.
* :c:var:`Py_BytesWarningFlag`:
Use :c:member:`PyConfig.bytes_warning` instead.
* :c:var:`Py_FrozenFlag`:
Use :c:member:`PyConfig.pathconfig_warnings` instead.
* :c:var:`Py_IgnoreEnvironmentFlag`:
Use :c:member:`PyConfig.use_environment` instead.
* :c:var:`Py_DontWriteBytecodeFlag`:
Use :c:member:`PyConfig.write_bytecode` instead.
* :c:var:`Py_NoUserSiteDirectory`:
Use :c:member:`PyConfig.user_site_directory` instead.
* :c:var:`Py_UnbufferedStdioFlag`:
Use :c:member:`PyConfig.buffered_stdio` instead.
* :c:var:`Py_HashRandomizationFlag`:
Use :c:member:`PyConfig.use_hash_seed`
and :c:member:`PyConfig.hash_seed` instead. and :c:member:`PyConfig.hash_seed` instead.
* :c:var:`Py_IsolatedFlag`: use :c:member:`PyConfig.isolated` instead. * :c:var:`Py_IsolatedFlag`:
* :c:var:`Py_LegacyWindowsFSEncodingFlag`: use :c:member:`PyPreConfig.legacy_windows_fs_encoding` instead. Use :c:member:`PyConfig.isolated` instead.
* :c:var:`Py_LegacyWindowsStdioFlag`: use :c:member:`PyConfig.legacy_windows_stdio` instead. * :c:var:`Py_LegacyWindowsFSEncodingFlag`:
* :c:var:`!Py_FileSystemDefaultEncoding`: use :c:member:`PyConfig.filesystem_encoding` instead. Use :c:member:`PyPreConfig.legacy_windows_fs_encoding` instead.
* :c:var:`!Py_HasFileSystemDefaultEncoding`: use :c:member:`PyConfig.filesystem_encoding` instead. * :c:var:`Py_LegacyWindowsStdioFlag`:
* :c:var:`!Py_FileSystemDefaultEncodeErrors`: use :c:member:`PyConfig.filesystem_errors` instead. Use :c:member:`PyConfig.legacy_windows_stdio` instead.
* :c:var:`!Py_UTF8Mode`: use :c:member:`PyPreConfig.utf8_mode` instead. (see :c:func:`Py_PreInitialize`) * :c:var:`!Py_FileSystemDefaultEncoding`:
Use :c:member:`PyConfig.filesystem_encoding` instead.
* :c:var:`!Py_HasFileSystemDefaultEncoding`:
Use :c:member:`PyConfig.filesystem_encoding` instead.
* :c:var:`!Py_FileSystemDefaultEncodeErrors`:
Use :c:member:`PyConfig.filesystem_errors` instead.
* :c:var:`!Py_UTF8Mode`:
Use :c:member:`PyPreConfig.utf8_mode` instead.
(see :c:func:`Py_PreInitialize`)
The :c:func:`Py_InitializeFromConfig` API should be used with The :c:func:`Py_InitializeFromConfig` API should be used with
:c:type:`PyConfig` instead. :c:type:`PyConfig` instead.

35
Doc/deprecations/c-api-pending-removal-in-3.15.rst
View File

@ -2,19 +2,26 @@ Pending Removal in Python 3.15
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* The bundled copy of ``libmpdecimal``. * The bundled copy of ``libmpdecimal``.
* :c:func:`PyImport_ImportModuleNoBlock`: use :c:func:`PyImport_ImportModule` instead. * The :c:func:`PyImport_ImportModuleNoBlock`:
* :c:func:`PyWeakref_GET_OBJECT`: use :c:func:`PyWeakref_GetRef` instead. Use :c:func:`PyImport_ImportModule` instead.
* :c:func:`PyWeakref_GetObject`: use :c:func:`PyWeakref_GetRef` instead. * :c:func:`PyWeakref_GetObject` and :c:func:`PyWeakref_GET_OBJECT`:
* :c:type:`!Py_UNICODE_WIDE` type: use :c:type:`wchar_t` instead. Use :c:func:`PyWeakref_GetRef` instead.
* :c:type:`Py_UNICODE` type: use :c:type:`wchar_t` instead. * :c:type:`Py_UNICODE` type and the :c:macro:`!Py_UNICODE_WIDE` macro:
Use :c:type:`wchar_t` instead.
* Python initialization functions: * Python initialization functions:
* :c:func:`PySys_ResetWarnOptions`: clear :data:`sys.warnoptions` and * :c:func:`PySys_ResetWarnOptions`:
:data:`!warnings.filters` instead. Clear :data:`sys.warnoptions` and :data:`!warnings.filters` instead.
* :c:func:`Py_GetExecPrefix`: get :data:`sys.exec_prefix` instead. * :c:func:`Py_GetExecPrefix`:
* :c:func:`Py_GetPath`: get :data:`sys.path` instead. Get :data:`sys.exec_prefix` instead.
* :c:func:`Py_GetPrefix`: get :data:`sys.prefix` instead. * :c:func:`Py_GetPath`:
* :c:func:`Py_GetProgramFullPath`: get :data:`sys.executable` instead. Get :data:`sys.path` instead.
* :c:func:`Py_GetProgramName`: get :data:`sys.executable` instead. * :c:func:`Py_GetPrefix`:
* :c:func:`Py_GetPythonHome`: get :c:member:`PyConfig.home` or Get :data:`sys.prefix` instead.
the :envvar:`PYTHONHOME` environment variable instead. * :c:func:`Py_GetProgramFullPath`:
Get :data:`sys.executable` instead.
* :c:func:`Py_GetProgramName`:
Get :data:`sys.executable` instead.
* :c:func:`Py_GetPythonHome`:
Get :c:member:`PyConfig.home`
or the :envvar:`PYTHONHOME` environment variable instead.

60
Doc/deprecations/c-api-pending-removal-in-future.rst
View File

@ -4,28 +4,48 @@ Pending Removal in Future Versions
The following APIs are deprecated and will be removed, The following APIs are deprecated and will be removed,
although there is currently no date scheduled for their removal. although there is currently no date scheduled for their removal.
* :c:macro:`Py_TPFLAGS_HAVE_FINALIZE`: unneeded since Python 3.8. * :c:macro:`Py_TPFLAGS_HAVE_FINALIZE`:
* :c:func:`PyErr_Fetch`: use :c:func:`PyErr_GetRaisedException` instead. Unneeded since Python 3.8.
* :c:func:`PyErr_NormalizeException`: use :c:func:`PyErr_GetRaisedException` instead. * :c:func:`PyErr_Fetch`:
* :c:func:`PyErr_Restore`: use :c:func:`PyErr_SetRaisedException` instead. Use :c:func:`PyErr_GetRaisedException` instead.
* :c:func:`PyModule_GetFilename`: use :c:func:`PyModule_GetFilenameObject` instead. * :c:func:`PyErr_NormalizeException`:
* :c:func:`PyOS_AfterFork`: use :c:func:`PyOS_AfterFork_Child` instead. Use :c:func:`PyErr_GetRaisedException` instead.
* :c:func:`PySlice_GetIndicesEx`: use :c:func:`PySlice_Unpack` and :c:func:`PySlice_AdjustIndices` instead. * :c:func:`PyErr_Restore`:
* :c:func:`!PyUnicode_AsDecodedObject`: use :c:func:`PyCodec_Decode` instead. Use :c:func:`PyErr_SetRaisedException` instead.
* :c:func:`!PyUnicode_AsDecodedUnicode`: use :c:func:`PyCodec_Decode` instead. * :c:func:`PyModule_GetFilename`:
* :c:func:`!PyUnicode_AsEncodedObject`: use :c:func:`PyCodec_Encode` instead. Use :c:func:`PyModule_GetFilenameObject` instead.
* :c:func:`!PyUnicode_AsEncodedUnicode`: use :c:func:`PyCodec_Encode` instead. * :c:func:`PyOS_AfterFork`:
* :c:func:`PyUnicode_READY`: unneeded since Python 3.12 Use :c:func:`PyOS_AfterFork_Child` instead.
* :c:func:`!PyErr_Display`: use :c:func:`PyErr_DisplayException` instead. * :c:func:`PySlice_GetIndicesEx`:
* :c:func:`!_PyErr_ChainExceptions`: use ``_PyErr_ChainExceptions1`` instead. Use :c:func:`PySlice_Unpack` and :c:func:`PySlice_AdjustIndices` instead.
* :c:func:`!PyUnicode_AsDecodedObject`:
Use :c:func:`PyCodec_Decode` instead.
* :c:func:`!PyUnicode_AsDecodedUnicode`:
Use :c:func:`PyCodec_Decode` instead.
* :c:func:`!PyUnicode_AsEncodedObject`:
Use :c:func:`PyCodec_Encode` instead.
* :c:func:`!PyUnicode_AsEncodedUnicode`:
Use :c:func:`PyCodec_Encode` instead.
* :c:func:`PyUnicode_READY`:
Unneeded since Python 3.12
* :c:func:`!PyErr_Display`:
Use :c:func:`PyErr_DisplayException` instead.
* :c:func:`!_PyErr_ChainExceptions`:
Use :c:func:`!_PyErr_ChainExceptions1` instead.
* :c:member:`!PyBytesObject.ob_shash` member: * :c:member:`!PyBytesObject.ob_shash` member:
call :c:func:`PyObject_Hash` instead. call :c:func:`PyObject_Hash` instead.
* :c:member:`!PyDictObject.ma_version_tag` member. * :c:member:`!PyDictObject.ma_version_tag` member.
* Thread Local Storage (TLS) API: * Thread Local Storage (TLS) API:
* :c:func:`PyThread_create_key`: use :c:func:`PyThread_tss_alloc` instead. * :c:func:`PyThread_create_key`:
* :c:func:`PyThread_delete_key`: use :c:func:`PyThread_tss_free` instead. Use :c:func:`PyThread_tss_alloc` instead.
* :c:func:`PyThread_set_key_value`: use :c:func:`PyThread_tss_set` instead. * :c:func:`PyThread_delete_key`:
* :c:func:`PyThread_get_key_value`: use :c:func:`PyThread_tss_get` instead. Use :c:func:`PyThread_tss_free` instead.
* :c:func:`PyThread_delete_key_value`: use :c:func:`PyThread_tss_delete` instead. * :c:func:`PyThread_set_key_value`:
* :c:func:`PyThread_ReInitTLS`: unneeded since Python 3.7. Use :c:func:`PyThread_tss_set` instead.
* :c:func:`PyThread_get_key_value`:
Use :c:func:`PyThread_tss_get` instead.
* :c:func:`PyThread_delete_key_value`:
Use :c:func:`PyThread_tss_delete` instead.
* :c:func:`PyThread_ReInitTLS`:
Unneeded since Python 3.7.

3
Doc/whatsnew/3.13.rst
View File

@ -2489,7 +2489,8 @@ Deprecated C APIs
or :c:func:`PyModule_AddObjectRef`. or :c:func:`PyModule_AddObjectRef`.
(Contributed by Serhiy Storchaka in :gh:`86493`.) (Contributed by Serhiy Storchaka in :gh:`86493`.)
* Deprecate the old ``Py_UNICODE`` and ``PY_UNICODE_TYPE`` types. * Deprecate the old ``Py_UNICODE`` and ``PY_UNICODE_TYPE`` types
and the :c:macro:`!Py_UNICODE_WIDE` define.
Use the :c:type:`wchar_t` type directly instead. Use the :c:type:`wchar_t` type directly instead.
Since Python 3.3, ``Py_UNICODE`` and ``PY_UNICODE_TYPE`` Since Python 3.3, ``Py_UNICODE`` and ``PY_UNICODE_TYPE``
are just aliases to :c:type:`!wchar_t`. are just aliases to :c:type:`!wchar_t`.