--- /dev/null
+Pending removal in Python 3.18
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+* Deprecated private functions (:gh:`128863`):
+
+ * :c:func:`!_PyBytes_Join`: use :c:func:`PyBytes_Join`.
+ * :c:func:`!_PyDict_GetItemStringWithError`: use :c:func:`PyDict_GetItemStringRef`.
+ * :c:func:`!_PyDict_Pop()`: :c:func:`PyDict_Pop`.
+ * :c:func:`!_PyThreadState_UncheckedGet`: use :c:func:`PyThreadState_GetUnchecked`.
+ * :c:func:`!_PyUnicode_AsString`: use :c:func:`PyUnicode_AsUTF8`.
+ * :c:func:`!_Py_HashPointer`: use :c:func:`Py_HashPointer`.
+ * :c:func:`!_Py_fopen_obj`: use :c:func:`Py_fopen`.
+
+ The `pythoncapi-compat project
+ <https://github.com/python/pythoncapi-compat/>`__ can be used to get these
+ new public functions on Python 3.13 and older.
.. include:: ../deprecations/c-api-pending-removal-in-3.15.rst
+.. include:: ../deprecations/c-api-pending-removal-in-3.18.rst
+
.. include:: ../deprecations/c-api-pending-removal-in-future.rst
* The ``PyMonitoring_FireBranchEvent`` function is deprecated and should
be replaced with calls to :c:func:`PyMonitoring_FireBranchLeftEvent`
and :c:func:`PyMonitoring_FireBranchRightEvent`.
+* The following private functions are deprecated and planned for removal in
+ Python 3.18:
+
+ * :c:func:`!_PyBytes_Join`: use :c:func:`PyBytes_Join`.
+ * :c:func:`!_PyDict_GetItemStringWithError`: use :c:func:`PyDict_GetItemStringRef`.
+ * :c:func:`!_PyDict_Pop()`: use :c:func:`PyDict_Pop`.
+ * :c:func:`!_PyThreadState_UncheckedGet`: use :c:func:`PyThreadState_GetUnchecked`.
+ * :c:func:`!_PyUnicode_AsString`: use :c:func:`PyUnicode_AsUTF8`.
+ * :c:func:`!_Py_HashPointer`: use :c:func:`Py_HashPointer`.
+ * :c:func:`!_Py_fopen_obj`: use :c:func:`Py_fopen`.
+
+ The `pythoncapi-compat project`_ can be used to get these new public
+ functions on Python 3.13 and older.
+
+ (Contributed by Victor Stinner in :gh:`128863`.)
+
+
Removed
-------
PyAPI_FUNC(PyObject*) PyBytes_Join(PyObject *sep, PyObject *iterable);
-// Alias kept for backward compatibility
-#define _PyBytes_Join PyBytes_Join
+// Deprecated alias kept for backward compatibility
+Py_DEPRECATED(3.14) static inline PyObject*
+_PyBytes_Join(PyObject *sep, PyObject *iterable)
+{
+ return PyBytes_Join(sep, iterable);
+}
PyAPI_FUNC(int) PyDict_Pop(PyObject *dict, PyObject *key, PyObject **result);
PyAPI_FUNC(int) PyDict_PopString(PyObject *dict, const char *key, PyObject **result);
-PyAPI_FUNC(PyObject *) _PyDict_Pop(PyObject *dict, PyObject *key, PyObject *default_value);
+
+// Use PyDict_Pop() instead
+Py_DEPRECATED(3.14) PyAPI_FUNC(PyObject *) _PyDict_Pop(
+ PyObject *dict,
+ PyObject *key,
+ PyObject *default_value);
/* Dictionary watchers */
PyObject *path,
const char *mode);
-// Deprecated alias to Py_fopen() kept for backward compatibility
-Py_DEPRECATED(3.14) PyAPI_FUNC(FILE*) _Py_fopen_obj(
- PyObject *path,
- const char *mode);
+// Deprecated alias kept for backward compatibility
+Py_DEPRECATED(3.14) static inline FILE*
+_Py_fopen_obj(PyObject *path, const char *mode)
+{
+ return Py_fopen(path, mode);
+}
PyAPI_FUNC(int) Py_fclose(FILE *file);
/* Helpers for hash functions */
PyAPI_FUNC(Py_hash_t) _Py_HashDouble(PyObject *, double);
-// Kept for backward compatibility
-#define _Py_HashPointer Py_HashPointer
-
/* hash function definition */
typedef struct {
PyAPI_FUNC(PyHash_FuncDef*) PyHash_GetFuncDef(void);
PyAPI_FUNC(Py_hash_t) Py_HashPointer(const void *ptr);
+
+// Deprecated alias kept for backward compatibility
+Py_DEPRECATED(3.14) static inline Py_hash_t
+_Py_HashPointer(const void *ptr)
+{
+ return Py_HashPointer(ptr);
+}
+
PyAPI_FUNC(Py_hash_t) PyObject_GenericHash(PyObject *);
PyAPI_FUNC(Py_hash_t) Py_HashBuffer(const void *ptr, Py_ssize_t len);
* if it is NULL. */
PyAPI_FUNC(PyThreadState *) PyThreadState_GetUnchecked(void);
-// Alias kept for backward compatibility
-#define _PyThreadState_UncheckedGet PyThreadState_GetUnchecked
+// Deprecated alias kept for backward compatibility
+Py_DEPRECATED(3.14) static inline PyThreadState*
+_PyThreadState_UncheckedGet(void)
+{
+ return PyThreadState_GetUnchecked();
+}
// Disable tracing and profiling.
PyAPI_FUNC(const char *) PyUnicode_AsUTF8(PyObject *unicode);
-// Alias kept for backward compatibility
-#define _PyUnicode_AsString PyUnicode_AsUTF8
+// Deprecated alias kept for backward compatibility
+Py_DEPRECATED(3.14) static inline const char*
+_PyUnicode_AsString(PyObject *unicode)
+{
+ return PyUnicode_AsUTF8(unicode);
+}
/* === Characters Type APIs =============================================== */
def test_open(testfn):
- # SSLContext.load_dh_params uses _Py_fopen_obj rather than normal open()
+ # SSLContext.load_dh_params uses Py_fopen() rather than normal open()
try:
import ssl
--- /dev/null
+The following private functions are deprecated and planned for removal in
+Python 3.18:
+
+* :c:func:`!_PyBytes_Join`: use :c:func:`PyBytes_Join`.
+* :c:func:`!_PyDict_GetItemStringWithError`: use :c:func:`PyDict_GetItemStringRef`.
+* :c:func:`!_PyDict_Pop()`: use :c:func:`PyDict_Pop`.
+* :c:func:`!_PyThreadState_UncheckedGet`: use :c:func:`PyThreadState_GetUnchecked`.
+* :c:func:`!_PyUnicode_AsString`: use :c:func:`PyUnicode_AsUTF8`.
+* :c:func:`!_Py_HashPointer`: use :c:func:`Py_HashPointer`.
+* :c:func:`!_Py_fopen_obj`: use :c:func:`Py_fopen`.
+
+The `pythoncapi-compat project
+<https://github.com/python/pythoncapi-compat/>`__ can be used to get these new
+public functions on Python 3.13 and older.
+
+Patch by Victor Stinner.
wrapperobject *wp = (wrapperobject *)self;
Py_hash_t x, y;
x = PyObject_GenericHash(wp->self);
- y = _Py_HashPointer(wp->descr);
+ y = Py_HashPointer(wp->descr);
x = x ^ y;
if (x == -1)
x = -2;
}
-PyObject *
-_PyDict_Pop(PyObject *dict, PyObject *key, PyObject *default_value)
+static PyObject *
+dict_pop_default(PyObject *dict, PyObject *key, PyObject *default_value)
{
PyObject *result;
if (PyDict_Pop(dict, key, &result) == 0) {
return result;
}
+PyObject *
+_PyDict_Pop(PyObject *dict, PyObject *key, PyObject *default_value)
+{
+ return dict_pop_default(dict, key, default_value);
+}
+
static PyDictObject *
dict_dict_fromkeys(PyInterpreterState *interp, PyDictObject *mp,
PyObject *iterable, PyObject *value)
dict_pop_impl(PyDictObject *self, PyObject *key, PyObject *default_value)
/*[clinic end generated code: output=3abb47b89f24c21c input=e221baa01044c44c]*/
{
- return _PyDict_Pop((PyObject*)self, key, default_value);
+ return dict_pop_default((PyObject*)self, key, default_value);
}
/*[clinic input]
{
PyCFunctionObject *a = _PyCFunctionObject_CAST(self);
Py_hash_t x = PyObject_GenericHash(a->m_self);
- Py_hash_t y = _Py_HashPointer((void*)(a->m_ml->ml_meth));
+ Py_hash_t y = Py_HashPointer((void*)(a->m_ml->ml_meth));
x ^= y;
if (x == -1) {
x = -2;
mp_subscript __getitem__ - dict_subscript
mp_ass_subscript __setitem__ - dict_ass_sub
__delitem__
-tp_hash __hash__ _Py_HashPointer ..._HashNotImpl
+tp_hash __hash__ Py_HashPointer ..._HashNotImpl
tp_str __str__ object_str -
tp_getattro __getattribute__ ..._GenericGetAttr (repeated)
__getattr__
return -1;
}
- Py_hash_t res = _Py_HashPointer(addr) ^ name_hash;
+ Py_hash_t res = Py_HashPointer(addr) ^ name_hash;
return res == -1 ? -2 : res;
}
}
-// Deprecated alias to Py_fopen() kept for backward compatibility
-FILE*
-_Py_fopen_obj(PyObject *path, const char *mode)
-{
- return Py_fopen(path, mode);
-}
-
-
// Call fclose().
//
// On Windows, files opened by Py_fopen() in the Python DLL must be closed by
projects / thirdparty / Python / cpython.git / commitdiff
