`dict.md`

219 строк · 15.8 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.10/c-api/dict.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# Объекты словарей89#### `type PyDictObject`1011Этот подтип [`PyObject`](https://python-all.ru/3.10/c-api/structures.html#c.PyObject) представляет объект словаря Python.1213#### `PyTypeObject PyDict_Type`1415*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*1617Этот экземпляр [`PyTypeObject`](https://python-all.ru/3.10/c-api/type.html#c.PyTypeObject) представляет тип словаря Python. Это тот же объект, что и [`dict`](https://python-all.ru/3.10/library/stdtypes.html#dict) на уровне Python.1819#### `int PyDict_Check(PyObject *p)`2021Возвращает True, если *p* – объект dict или экземпляр подтипа типа dict. Эта функция всегда завершается успешно.2223#### `int PyDict_CheckExact(PyObject *p)`2425Возвращает True, если *p* – объект dict, но не экземпляр подтипа типа dict. Эта функция всегда завершается успешно.2627#### `PyObject *PyDict_New()`2829*Возвращаемое значение: новая ссылка.*3031*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*3233Возвращает новый пустой словарь или `NULL` в случае ошибки.3435#### `PyObject *PyDictProxy_New(PyObject *mapping)`3637*Возвращаемое значение: новая ссылка.*3839*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*4041Возвращает объект [`types.MappingProxyType`](https://python-all.ru/3.10/library/types.html#types.MappingProxyType) для отображения, которое принудительно обеспечивает режим только для чтения. Обычно используется для создания представления, предотвращающего изменение словаря для нединамических типов классов.4243#### `void PyDict_Clear(PyObject *p)`4445*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*4647Очищает существующий словарь от всех пар ключ-значение.4849#### `int PyDict_Contains(PyObject *p, PyObject *key)`5051*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*5253Определяет, содержит ли словарь *p* ключ *key*. Если элемент в *p* совпадает с *key*, возвращает `1`, иначе возвращает `0`. В случае ошибки возвращает `-1`. Это эквивалентно выражению Python `key in p`.5455#### `PyObject *PyDict_Copy(PyObject *p)`5657*Возвращаемое значение: новая ссылка.*5859*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*6061Возвращает новый словарь, содержащий те же пары ключ-значение, что и *p*.6263#### `int PyDict_SetItem(PyObject *p, PyObject *key, PyObject *val)`6465*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*6667Вставляет *val* в словарь *p* с ключом *key*. *key* должен быть [хешируемым](https://python-all.ru/3.10/glossary.html#term-hashable); в противном случае будет возбуждено [`TypeError`](https://python-all.ru/3.10/library/exceptions.html#TypeError). Возвращает `0` в случае успеха или `-1` при неудаче. Эта функция *не* похищает ссылку на *val*.6869#### `int PyDict_SetItemString(PyObject *p, const char *key, PyObject *val)`7071*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*7273Вставляет *val* в словарь *p*, используя *key* в качестве ключа. *key* должен быть `const char*`. Объект ключа создаётся с помощью `PyUnicode_FromString(key)`. Возвращает `0` в случае успеха или `-1` в случае ошибки. Эта функция *не* крадёт ссылку на *val*.7475#### `int PyDict_DelItem(PyObject *p, PyObject *key)`7677*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*7879Удаляет запись из словаря *p* с ключом *key*. *key* должен быть [хэшируемым](https://python-all.ru/3.10/glossary.html#term-hashable); если нет, возбуждается [`TypeError`](https://python-all.ru/3.10/library/exceptions.html#TypeError). Если *key* отсутствует в словаре, возбуждается [`KeyError`](https://python-all.ru/3.10/library/exceptions.html#KeyError). Возвращает `0` при успехе или `-1` при неудаче.8081#### `int PyDict_DelItemString(PyObject *p, const char *key)`8283*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*8485Удаляет запись из словаря *p*, ключ которой задаётся строкой *key*. Если *key* нет в словаре, возбуждается исключение [`KeyError`](https://python-all.ru/3.10/library/exceptions.html#KeyError). Возвращает `0` в случае успеха или `-1` в случае ошибки.8687#### `PyObject *PyDict_GetItem(PyObject *p, PyObject *key)`8889*Возвращаемое значение: заимствованная ссылка.*9091*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*9293Возвращает объект из словаря *p* по ключу *key*. Возвращает `NULL`, если ключ *key* отсутствует, но *без* установки исключения.9495Обратите внимание, что исключения, возникающие при вызове методов `__hash__()` и `__eq__()`, подавляются. Для получения сообщений об ошибках используйте вместо этого [`PyDict_GetItemWithError()`](https://python-all.ru/3.10/c-api/dict.html#c.PyDict_GetItemWithError).9697Изменено в версии 3.10: Вызов этого API без удержания [GIL](https://python-all.ru/3.10/glossary.html#term-GIL) ранее допускался по историческим причинам. Теперь это не допускается.9899#### `PyObject *PyDict_GetItemWithError(PyObject *p, PyObject *key)`100101*Возвращаемое значение: заимствованная ссылка.*102103*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*104105Вариант [`PyDict_GetItem()`](https://python-all.ru/3.10/c-api/dict.html#c.PyDict_GetItem), который не подавляет исключения. Возвращает `NULL` **с** установленным исключением, если произошло исключение. Возвращает `NULL` **без** установленного исключения, если ключ отсутствовал.106107#### `PyObject *PyDict_GetItemString(PyObject *p, const char *key)`108109*Возвращаемое значение: заимствованная ссылка.*110111*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*112113То же, что и [`PyDict_GetItem()`](https://python-all.ru/3.10/c-api/dict.html#c.PyDict_GetItem), но *key* задаётся как `const char*`, а не как `PyObject*`.114115Обратите внимание, что исключения, возникающие при вызове методов `__hash__()` и `__eq__()` и при создании временного строкового объекта, подавляются. Для получения сообщений об ошибках используйте вместо этого [`PyDict_GetItemWithError()`](https://python-all.ru/3.10/c-api/dict.html#c.PyDict_GetItemWithError).116117#### `PyObject *PyDict_SetDefault(PyObject *p, PyObject *key, PyObject *defaultobj)`118119*Возвращаемое значение: заимствованная ссылка.*120121Это то же самое, что и функция [`dict.setdefault()`](https://python-all.ru/3.10/library/stdtypes.html#dict.setdefault) на уровне Python. Если значение присутствует, она возвращает значение, соответствующее *key*, из словаря *p*. Если ключ отсутствует в словаре, он вставляется со значением *defaultobj* и возвращается *defaultobj*. Эта функция вычисляет хеш-функцию для *key* только один раз, вместо того чтобы вычислять её отдельно для поиска и вставки.122123Новое в версии 3.4.124125#### `PyObject *PyDict_Items(PyObject *p)`126127*Возвращаемое значение: новая ссылка.*128129*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*130131Возвращает [`PyListObject`](https://python-all.ru/3.10/c-api/list.html#c.PyListObject), содержащий все элементы из словаря.132133#### `PyObject *PyDict_Keys(PyObject *p)`134135*Возвращаемое значение: новая ссылка.*136137*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*138139Возвращает [`PyListObject`](https://python-all.ru/3.10/c-api/list.html#c.PyListObject), содержащий все ключи из словаря.140141#### `PyObject *PyDict_Values(PyObject *p)`142143*Возвращаемое значение: новая ссылка.*144145*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*146147Возвращает [`PyListObject`](https://python-all.ru/3.10/c-api/list.html#c.PyListObject), содержащий все значения из словаря *p*.148149#### `Py_ssize_t PyDict_Size(PyObject *p)`150151*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*152153Возвращает количество элементов в словаре. Это эквивалентно вызову `len(p)` для словаря.154155#### `int PyDict_Next(PyObject *p, Py_ssize_t *ppos, PyObject **pkey, PyObject **pvalue)`156157*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*158159Перебирает все пары ключ-значение в словаре *p*. Переменная [`Py_ssize_t`](https://python-all.ru/3.10/c-api/intro.html#c.Py_ssize_t), на которую указывает *ppos*, должна быть инициализирована значением `0` перед первым вызовом этой функции для начала итерации; функция возвращает true для каждой пары в словаре и false, когда все пары сообщены. Параметры *pkey* и *pvalue* должны либо указывать на переменные `PyObject*`, которые будут заполнены каждым ключом и значением соответственно, либо могут быть `NULL`. Любые ссылки, возвращаемые через них, являются заимствованными. *ppos* не следует изменять во время итерации. Его значение представляет собой смещения во внутренней структуре словаря, и поскольку структура разрежена, смещения не являются последовательными.160161Например:162163```c164PyObject *key, *value;165Py_ssize_t pos = 0;166167while (PyDict_Next(self->dict, &pos, &key, &value)) {168    /* сделайте что-нибудь интересное со значениями... */169    ...170}171```172173Словарь *p* не должен изменяться во время итерации. Можно безопасно изменять значения ключей при переборе словаря, но только до тех пор, пока набор ключей не меняется. Например:174175```c176PyObject *key, *value;177Py_ssize_t pos = 0;178179while (PyDict_Next(self->dict, &pos, &key, &value)) {180    long i = PyLong_AsLong(value);181    if (i == -1 && PyErr_Occurred()) {182        return -1;183    }184    PyObject *o = PyLong_FromLong(i + 1);185    if (o == NULL)186        return -1;187    if (PyDict_SetItem(self->dict, key, o) < 0) {188        Py_DECREF(o);189        return -1;190    }191    Py_DECREF(o);192}193```194195#### `int PyDict_Merge(PyObject *a, PyObject *b, int override)`196197*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*198199Перебирает объект отображения *b*, добавляя пары ключ-значение в словарь *a*. *b* может быть словарем или любым объектом, поддерживающим [`PyMapping_Keys()`](https://python-all.ru/3.10/c-api/mapping.html#c.PyMapping_Keys) и [`PyObject_GetItem()`](https://python-all.ru/3.10/c-api/object.html#c.PyObject_GetItem). Если *override* равно true, существующие пары в *a* будут заменены, если найден совпадающий ключ в *b*; в противном случае пары будут добавлены только если нет совпадающего ключа в *a*. Возвращает `0` при успехе или `-1`, если было возбуждено исключение.200201#### `int PyDict_Update(PyObject *a, PyObject *b)`202203*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*204205То же самое, что и `PyDict_Merge(a, b, 1)` в C, и похоже на `a.update(b)` в Python, за исключением того, что [`PyDict_Update()`](https://python-all.ru/3.10/c-api/dict.html#c.PyDict_Update) не переходит к итерации по последовательности пар ключ-значение, если у второго аргумента нет атрибута “keys”. Возвращает `0` при успехе или `-1`, если было возбуждено исключение.206207#### `int PyDict_MergeFromSeq2(PyObject *a, PyObject *seq2, int override)`208209*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*210211Обновляет или объединяет словарь *a*, используя пары ключ-значение из *seq2*. *seq2* должен быть итерируемым объектом, который возвращает итерируемые объекты длины 2, рассматриваемые как пары ключ-значение. При повторяющихся ключах последнее значение побеждает, если *override* истинно, иначе первое. Возвращает `0` при успехе или `-1`, если возникло исключение. Эквивалент на Python (за исключением возвращаемого значения):212213```c214def PyDict_MergeFromSeq2(a, seq2, override):215    for key, value in seq2:216        if override or key not in a:217            a[key] = value218```219