mirror of
https://github.com/python/cpython.git
synced 2026-01-28 18:22:17 +00:00
a8a89fcd1f
* gh-106320: Re-add _PyLong_FromByteArray(), _PyLong_AsByteArray() and _PyLong_GCD() to the public header files since they are used by third-party packages and there is no efficient replacement. See https://github.com/python/cpython/issues/111140 See https://github.com/python/cpython/issues/111139 * gh-111262: Re-add _PyDict_Pop() to have a C-API until a new public one is designed.
78 lines
2.5 KiB
C
78 lines
2.5 KiB
C
#ifndef Py_CPYTHON_DICTOBJECT_H
|
|
# error "this header file must not be included directly"
|
|
#endif
|
|
|
|
typedef struct _dictkeysobject PyDictKeysObject;
|
|
typedef struct _dictvalues PyDictValues;
|
|
|
|
/* The ma_values pointer is NULL for a combined table
|
|
* or points to an array of PyObject* for a split table
|
|
*/
|
|
typedef struct {
|
|
PyObject_HEAD
|
|
|
|
/* Number of items in the dictionary */
|
|
Py_ssize_t ma_used;
|
|
|
|
/* Dictionary version: globally unique, value change each time
|
|
the dictionary is modified */
|
|
#ifdef Py_BUILD_CORE
|
|
uint64_t ma_version_tag;
|
|
#else
|
|
Py_DEPRECATED(3.12) uint64_t ma_version_tag;
|
|
#endif
|
|
|
|
PyDictKeysObject *ma_keys;
|
|
|
|
/* If ma_values is NULL, the table is "combined": keys and values
|
|
are stored in ma_keys.
|
|
|
|
If ma_values is not NULL, the table is split:
|
|
keys are stored in ma_keys and values are stored in ma_values */
|
|
PyDictValues *ma_values;
|
|
} PyDictObject;
|
|
|
|
PyAPI_FUNC(PyObject *) PyDict_SetDefault(
|
|
PyObject *mp, PyObject *key, PyObject *defaultobj);
|
|
|
|
/* Get the number of items of a dictionary. */
|
|
static inline Py_ssize_t PyDict_GET_SIZE(PyObject *op) {
|
|
PyDictObject *mp;
|
|
assert(PyDict_Check(op));
|
|
mp = _Py_CAST(PyDictObject*, op);
|
|
return mp->ma_used;
|
|
}
|
|
#define PyDict_GET_SIZE(op) PyDict_GET_SIZE(_PyObject_CAST(op))
|
|
|
|
PyAPI_FUNC(int) PyDict_ContainsString(PyObject *mp, const char *key);
|
|
|
|
PyAPI_FUNC(PyObject *) _PyDict_Pop(PyObject *dict, PyObject *key, PyObject *default_value);
|
|
|
|
/* Dictionary watchers */
|
|
|
|
#define PY_FOREACH_DICT_EVENT(V) \
|
|
V(ADDED) \
|
|
V(MODIFIED) \
|
|
V(DELETED) \
|
|
V(CLONED) \
|
|
V(CLEARED) \
|
|
V(DEALLOCATED)
|
|
|
|
typedef enum {
|
|
#define PY_DEF_EVENT(EVENT) PyDict_EVENT_##EVENT,
|
|
PY_FOREACH_DICT_EVENT(PY_DEF_EVENT)
|
|
#undef PY_DEF_EVENT
|
|
} PyDict_WatchEvent;
|
|
|
|
// Callback to be invoked when a watched dict is cleared, dealloced, or modified.
|
|
// In clear/dealloc case, key and new_value will be NULL. Otherwise, new_value will be the
|
|
// new value for key, NULL if key is being deleted.
|
|
typedef int(*PyDict_WatchCallback)(PyDict_WatchEvent event, PyObject* dict, PyObject* key, PyObject* new_value);
|
|
|
|
// Register/unregister a dict-watcher callback
|
|
PyAPI_FUNC(int) PyDict_AddWatcher(PyDict_WatchCallback callback);
|
|
PyAPI_FUNC(int) PyDict_ClearWatcher(int watcher_id);
|
|
|
|
// Mark given dictionary as "watched" (callback will be called if it is modified)
|
|
PyAPI_FUNC(int) PyDict_Watch(int watcher_id, PyObject* dict);
|
|
PyAPI_FUNC(int) PyDict_Unwatch(int watcher_id, PyObject* dict);
|