Obiekty słownika¶
-
PyTypeObject PyDict_Type¶
- Część stabilnego ABI.
Ta instancja
PyTypeObjectreprezentuje typ słownika Pythona. Jest to ten sam obiekt, codictw warstwie Pythona.
-
int PyDict_Check(PyObject *p)¶
Zwraca wartość true, jeśli p jest obiektem typu dict lub instancją podtypu typu dict. Funkcja ta zawsze kończy się powodzeniem.
-
int PyDict_CheckExact(PyObject *p)¶
Zwraca wartość true, jeśli p jest obiektem typu dict, ale nie jest instancją podtypu typu dict. Funkcja ta zawsze kończy się powodzeniem.
-
PyObject *PyDict_New()¶
- Wartość zwracana: nowa referencja. Część stabilnego ABI.
Zwraca nowy pusty słownik lub
NULLw przypadku niepowodzenia.
-
PyObject *PyDictProxy_New(PyObject *mapping)¶
- Wartość zwracana: nowa referencja. Część stabilnego ABI.
Return a
types.MappingProxyTypeobject for a mapping which enforces read-only behavior. This is normally used to create a view to prevent modification of the dictionary for non-dynamic class types.
-
void PyDict_Clear(PyObject *p)¶
- Część stabilnego ABI.
Empty an existing dictionary of all key-value pairs.
-
int PyDict_Contains(PyObject *p, PyObject *key)¶
- Część stabilnego ABI.
Determine if dictionary p contains key. If an item in p is matches key, return
1, otherwise return0. On error, return-1. This is equivalent to the Python expressionkey in p.
-
int PyDict_ContainsString(PyObject *p, const char *key)¶
This is the same as
PyDict_Contains(), but key is specified as a const char* UTF-8 encoded bytes string, rather than a PyObject*.Dodane w wersji 3.13.
-
PyObject *PyDict_Copy(PyObject *p)¶
- Wartość zwracana: nowa referencja. Część stabilnego ABI.
Zwraca nowy słownik zawierający te same pary klucz-wartość co p.
-
int PyDict_SetItem(PyObject *p, PyObject *key, PyObject *val)¶
- Część stabilnego ABI.
Insert val into the dictionary p with a key of key. key must be hashable; if it isn’t,
TypeErrorwill be raised. Return0on success or-1on failure. This function does not steal a reference to val.
-
int PyDict_SetItemString(PyObject *p, const char *key, PyObject *val)¶
- Część stabilnego ABI.
This is the same as
PyDict_SetItem(), but key is specified as a const char* UTF-8 encoded bytes string, rather than a PyObject*.
-
int PyDict_DelItem(PyObject *p, PyObject *key)¶
- Część stabilnego ABI.
Remove the entry in dictionary p with key key. key must be hashable; if it isn’t,
TypeErroris raised. If key is not in the dictionary,KeyErroris raised. Return0on success or-1on failure.
-
int PyDict_DelItemString(PyObject *p, const char *key)¶
- Część stabilnego ABI.
This is the same as
PyDict_DelItem(), but key is specified as a const char* UTF-8 encoded bytes string, rather than a PyObject*.
-
int PyDict_GetItemRef(PyObject *p, PyObject *key, PyObject **result)¶
- Część stabilnego ABI od wersji 3.13.
Return a new strong reference to the object from dictionary p which has a key key:
If the key is present, set *result to a new strong reference to the value and return
1.If the key is missing, set *result to
NULLand return0.On error, raise an exception and return
-1.
Dodane w wersji 3.13.
See also the
PyObject_GetItem()function.
-
PyObject *PyDict_GetItem(PyObject *p, PyObject *key)¶
- Wartość zwracana: pożyczona referencja. Część stabilnego ABI.
Return a borrowed reference to the object from dictionary p which has a key key. Return
NULLif the key key is missing without setting an exception.Informacja
Exceptions that occur while this calls
__hash__()and__eq__()methods are silently ignored. Prefer thePyDict_GetItemWithError()function instead.Zmienione w wersji 3.10: Calling this API without GIL held had been allowed for historical reason. It is no longer allowed.
-
PyObject *PyDict_GetItemWithError(PyObject *p, PyObject *key)¶
- Wartość zwracana: pożyczona referencja. Część stabilnego ABI.
Variant of
PyDict_GetItem()that does not suppress exceptions. ReturnNULLwith an exception set if an exception occurred. ReturnNULLwithout an exception set if the key wasn’t present.
-
PyObject *PyDict_GetItemString(PyObject *p, const char *key)¶
- Wartość zwracana: pożyczona referencja. Część stabilnego ABI.
This is the same as
PyDict_GetItem(), but key is specified as a const char* UTF-8 encoded bytes string, rather than a PyObject*.Informacja
Exceptions that occur while this calls
__hash__()and__eq__()methods or while creating the temporarystrobject are silently ignored. Prefer using thePyDict_GetItemWithError()function with your ownPyUnicode_FromString()key instead.
-
int PyDict_GetItemStringRef(PyObject *p, const char *key, PyObject **result)¶
- Część stabilnego ABI od wersji 3.13.
Similar to
PyDict_GetItemRef(), but key is specified as a const char* UTF-8 encoded bytes string, rather than a PyObject*.Dodane w wersji 3.13.
-
PyObject *PyDict_SetDefault(PyObject *p, PyObject *key, PyObject *defaultobj)¶
- Wartość zwracana: pożyczona referencja.
This is the same as the Python-level
dict.setdefault(). If present, it returns the value corresponding to key from the dictionary p. If the key is not in the dict, it is inserted with value defaultobj and defaultobj is returned. This function evaluates the hash function of key only once, instead of evaluating it independently for the lookup and the insertion.Dodane w wersji 3.4.
-
int PyDict_SetDefaultRef(PyObject *p, PyObject *key, PyObject *default_value, PyObject **result)¶
Inserts default_value into the dictionary p with a key of key if the key is not already present in the dictionary. If result is not
NULL, then *result is set to a strong reference to either default_value, if the key was not present, or the existing value, if key was already present in the dictionary. Returns1if the key was present and default_value was not inserted, or0if the key was not present and default_value was inserted. On failure, returns-1, sets an exception, and sets*resulttoNULL.For clarity: if you have a strong reference to default_value before calling this function, then after it returns, you hold a strong reference to both default_value and *result (if it’s not
NULL). These may refer to the same object: in that case you hold two separate references to it.Dodane w wersji 3.13.
-
int PyDict_Pop(PyObject *p, PyObject *key, PyObject **result)¶
Remove key from dictionary p and optionally return the removed value. Do not raise
KeyErrorif the key missing.If the key is present, set *result to a new reference to the removed value if result is not
NULL, and return1.If the key is missing, set *result to
NULLif result is notNULL, and return0.On error, raise an exception and return
-1.
Similar to
dict.pop(), but without the default value and not raisingKeyErrorif the key missing.Dodane w wersji 3.13.
-
int PyDict_PopString(PyObject *p, const char *key, PyObject **result)¶
Similar to
PyDict_Pop(), but key is specified as a const char* UTF-8 encoded bytes string, rather than a PyObject*.Dodane w wersji 3.13.
-
PyObject *PyDict_Items(PyObject *p)¶
- Wartość zwracana: nowa referencja. Część stabilnego ABI.
Return a
PyListObjectcontaining all the items from the dictionary.
-
PyObject *PyDict_Keys(PyObject *p)¶
- Wartość zwracana: nowa referencja. Część stabilnego ABI.
Return a
PyListObjectcontaining all the keys from the dictionary.
-
PyObject *PyDict_Values(PyObject *p)¶
- Wartość zwracana: nowa referencja. Część stabilnego ABI.
Zwraca
PyListObjectzawierający wszystkie wartości ze słownika p.
-
Py_ssize_t PyDict_Size(PyObject *p)¶
- Część stabilnego ABI.
Return the number of items in the dictionary. This is equivalent to
len(p)on a dictionary.
-
int PyDict_Next(PyObject *p, Py_ssize_t *ppos, PyObject **pkey, PyObject **pvalue)¶
- Część stabilnego ABI.
Iterate over all key-value pairs in the dictionary p. The
Py_ssize_treferred to by ppos must be initialized to0prior to the first call to this function to start the iteration; the function returns true for each pair in the dictionary, and false once all pairs have been reported. The parameters pkey and pvalue should either point to PyObject* variables that will be filled in with each key and value, respectively, or may beNULL. Any references returned through them are borrowed. ppos should not be altered during iteration. Its value represents offsets within the internal dictionary structure, and since the structure is sparse, the offsets are not consecutive.Dla przykładu:
PyObject *key, *value; Py_ssize_t pos = 0; while (PyDict_Next(self->dict, &pos, &key, &value)) { /* do something interesting with the values... */ ... }
The dictionary p should not be mutated during iteration. It is safe to modify the values of the keys as you iterate over the dictionary, but only so long as the set of keys does not change. For example:
PyObject *key, *value; Py_ssize_t pos = 0; while (PyDict_Next(self->dict, &pos, &key, &value)) { long i = PyLong_AsLong(value); if (i == -1 && PyErr_Occurred()) { return -1; } PyObject *o = PyLong_FromLong(i + 1); if (o == NULL) return -1; if (PyDict_SetItem(self->dict, key, o) < 0) { Py_DECREF(o); return -1; } Py_DECREF(o); }
The function is not thread-safe in the free-threaded build without external synchronization. You can use
Py_BEGIN_CRITICAL_SECTIONto lock the dictionary while iterating over it:Py_BEGIN_CRITICAL_SECTION(self->dict); while (PyDict_Next(self->dict, &pos, &key, &value)) { ... } Py_END_CRITICAL_SECTION();
-
int PyDict_Merge(PyObject *a, PyObject *b, int override)¶
- Część stabilnego ABI.
Iterate over mapping object b adding key-value pairs to dictionary a. b may be a dictionary, or any object supporting
PyMapping_Keys()andPyObject_GetItem(). If override is true, existing pairs in a will be replaced if a matching key is found in b, otherwise pairs will only be added if there is not a matching key in a. Return0on success or-1if an exception was raised.
-
int PyDict_Update(PyObject *a, PyObject *b)¶
- Część stabilnego ABI.
This is the same as
PyDict_Merge(a, b, 1)in C, and is similar toa.update(b)in Python except thatPyDict_Update()doesn’t fall back to the iterating over a sequence of key value pairs if the second argument has no „keys” attribute. Return0on success or-1if an exception was raised.
-
int PyDict_MergeFromSeq2(PyObject *a, PyObject *seq2, int override)¶
- Część stabilnego ABI.
Update or merge into dictionary a, from the key-value pairs in seq2. seq2 must be an iterable object producing iterable objects of length 2, viewed as key-value pairs. In case of duplicate keys, the last wins if override is true, else the first wins. Return
0on success or-1if an exception was raised. Equivalent Python (except for the return value):def PyDict_MergeFromSeq2(a, seq2, override): for key, value in seq2: if override or key not in a: a[key] = value
-
int PyDict_AddWatcher(PyDict_WatchCallback callback)¶
Register callback as a dictionary watcher. Return a non-negative integer id which must be passed to future calls to
PyDict_Watch(). In case of error (e.g. no more watcher IDs available), return-1and set an exception.Dodane w wersji 3.12.
-
int PyDict_ClearWatcher(int watcher_id)¶
Clear watcher identified by watcher_id previously returned from
PyDict_AddWatcher(). Return0on success,-1on error (e.g. if the given watcher_id was never registered.)Dodane w wersji 3.12.
-
int PyDict_Watch(int watcher_id, PyObject *dict)¶
Mark dictionary dict as watched. The callback granted watcher_id by
PyDict_AddWatcher()will be called when dict is modified or deallocated. Return0on success or-1on error.Dodane w wersji 3.12.
-
int PyDict_Unwatch(int watcher_id, PyObject *dict)¶
Mark dictionary dict as no longer watched. The callback granted watcher_id by
PyDict_AddWatcher()will no longer be called when dict is modified or deallocated. The dict must previously have been watched by this watcher. Return0on success or-1on error.Dodane w wersji 3.12.
-
type PyDict_WatchEvent¶
Enumeration of possible dictionary watcher events:
PyDict_EVENT_ADDED,PyDict_EVENT_MODIFIED,PyDict_EVENT_DELETED,PyDict_EVENT_CLONED,PyDict_EVENT_CLEARED, orPyDict_EVENT_DEALLOCATED.Dodane w wersji 3.12.
-
typedef int (*PyDict_WatchCallback)(PyDict_WatchEvent event, PyObject *dict, PyObject *key, PyObject *new_value)¶
Type of a dict watcher callback function.
If event is
PyDict_EVENT_CLEAREDorPyDict_EVENT_DEALLOCATED, both key and new_value will beNULL. If event isPyDict_EVENT_ADDEDorPyDict_EVENT_MODIFIED, new_value will be the new value for key. If event isPyDict_EVENT_DELETED, key is being deleted from the dictionary and new_value will beNULL.PyDict_EVENT_CLONEDoccurs when dict was previously empty and another dict is merged into it. To maintain efficiency of this operation, per-keyPyDict_EVENT_ADDEDevents are not issued in this case; instead a singlePyDict_EVENT_CLONEDis issued, and key will be the source dictionary.The callback may inspect but must not modify dict; doing so could have unpredictable effects, including infinite recursion. Do not trigger Python code execution in the callback, as it could modify the dict as a side effect.
If event is
PyDict_EVENT_DEALLOCATED, taking a new reference in the callback to the about-to-be-destroyed dictionary will resurrect it and prevent it from being freed at this time. When the resurrected object is destroyed later, any watcher callbacks active at that time will be called again.Callbacks occur before the notified modification to dict takes place, so the prior state of dict can be inspected.
If the callback sets an exception, it must return
-1; this exception will be printed as an unraisable exception usingPyErr_WriteUnraisable(). Otherwise it should return0.There may already be a pending exception set on entry to the callback. In this case, the callback should return
0with the same exception still set. This means the callback may not call any other API that can set an exception unless it saves and clears the exception state first, and restores it before returning.Dodane w wersji 3.12.