`dict.md`

179 строк · 13.7 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.6/c-api/dict.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# Объекты словарей89**`PyDictObject`**1011Этот подтип [`PyObject`](https://python-all.ru/3.6/c-api/structures.html#c.PyObject) представляет объект словаря Python.1213**[PyTypeObject](https://python-all.ru/3.6/c-api/type.html#c.PyTypeObject) `PyDict_Type`**1415Этот экземпляр [`PyTypeObject`](https://python-all.ru/3.6/c-api/type.html#c.PyTypeObject) представляет тип словаря Python. Это тот же объект, что и [`dict`](https://python-all.ru/3.6/library/stdtypes.html#dict) на уровне Python.1617#### `int PyDict_Check(PyObject *p)`1819Возвращает true, если *p* является объектом dict или экземпляром подтипа типа dict.2021#### `int PyDict_CheckExact(PyObject *p)`2223Возвращает true, если *p* является объектом dict, но не экземпляром подтипа tипа dict.2425#### `PyObject* PyDict_New()`2627*Возвращаемое значение: новая ссылка.*2829Возвращает новый пустой словарь или *NULL* в случае ошибки.3031#### `PyObject* PyDictProxy_New(PyObject *mapping)`3233*Возвращаемое значение: новая ссылка.*3435Возвращает объект [`types.MappingProxyType`](https://python-all.ru/3.6/library/types.html#types.MappingProxyType) для отображения, которое принудительно обеспечивает режим только для чтения. Обычно используется для создания представления, предотвращающего изменение словаря для нединамических типов классов.3637#### `void PyDict_Clear(PyObject *p)`3839Очищает существующий словарь от всех пар ключ-значение.4041#### `int PyDict_Contains(PyObject *p, PyObject *key)`4243Определяет, содержит ли словарь *p* ключ *key*. Если элемент в *p* совпадает с *key*, возвращает `1`, иначе возвращает `0`. В случае ошибки возвращает `-1`. Это эквивалентно выражению Python `key in p`.4445#### `PyObject* PyDict_Copy(PyObject *p)`4647*Возвращаемое значение: новая ссылка.*4849Возвращает новый словарь, содержащий те же пары ключ-значение, что и *p*.5051#### `int PyDict_SetItem(PyObject *p, PyObject *key, PyObject *val)`5253Вставляет *value* в словарь *p* с ключом *key*. *key* должен быть [хэшируемым](https://python-all.ru/3.6/glossary.html#term-hashable); в противном случае будет возбуждено [`TypeError`](https://python-all.ru/3.6/library/exceptions.html#TypeError). Возвращает `0` при успехе или `-1` при неудаче.5455#### `int PyDict_SetItemString(PyObject *p, const char *key, PyObject *val)`5657Вставляет *value* в словарь *p*, используя *key* в качестве ключа. *key* должен быть `char*`. Объект ключа создаётся с помощью `PyUnicode_FromString(key)`. Возвращает `0` при успехе или `-1` при неудаче.5859#### `int PyDict_DelItem(PyObject *p, PyObject *key)`6061Удаляет запись из словаря *p* с ключом *key*. *key* должен быть хэшируемым; в противном случае возбуждается [`TypeError`](https://python-all.ru/3.6/library/exceptions.html#TypeError). Возвращает `0` при успехе или `-1` при неудаче.6263#### `int PyDict_DelItemString(PyObject *p, const char *key)`6465Удаляет запись из словаря *p*, ключ которой задаётся строкой *key*. Возвращает `0` при успехе или `-1` при неудаче.6667#### `PyObject* PyDict_GetItem(PyObject *p, PyObject *key)`6869*Возвращаемое значение: заимствованная ссылка.*7071Возвращает объект из словаря *p* с ключом *key*. Возвращает *NULL* если ключ *key* отсутствует, но *без* установки исключения.7273Обратите внимание, что исключения, возникающие при вызове методов [`__hash__()`](https://python-all.ru/3.6/reference/datamodel.html#object.__hash__) и [`__eq__()`](https://python-all.ru/3.6/reference/datamodel.html#object.__eq__), подавляются. Для получения сообщений об ошибках используйте вместо этого [`PyDict_GetItemWithError()`](https://python-all.ru/3.6/c-api/dict.html#c.PyDict_GetItemWithError).7475#### `PyObject* PyDict_GetItemWithError(PyObject *p, PyObject *key)`7677Вариант [`PyDict_GetItem()`](https://python-all.ru/3.6/c-api/dict.html#c.PyDict_GetItem), не подавляющий исключения. Возвращает *NULL* **с** установленным исключением, если произошло исключение. Возвращает *NULL* **без** установленного исключения, если ключ отсутствовал.7879#### `PyObject* PyDict_GetItemString(PyObject *p, const char *key)`8081*Возвращаемое значение: заимствованная ссылка.*8283То же, что и [`PyDict_GetItem()`](https://python-all.ru/3.6/c-api/dict.html#c.PyDict_GetItem), но *key* задаётся как `char*`, а не как [`PyObject*`](https://python-all.ru/3.6/c-api/structures.html#c.PyObject).8485Обратите внимание, что исключения, возникающие при вызове методов [`__hash__()`](https://python-all.ru/3.6/reference/datamodel.html#object.__hash__) и [`__eq__()`](https://python-all.ru/3.6/reference/datamodel.html#object.__eq__) и при создании временного строкового объекта, подавляются. Для получения сообщений об ошибках используйте вместо этого [`PyDict_GetItemWithError()`](https://python-all.ru/3.6/c-api/dict.html#c.PyDict_GetItemWithError).8687#### `PyObject* PyDict_SetDefault(PyObject *p, PyObject *key, PyObject *default)`8889*Возвращаемое значение: заимствованная ссылка.*9091Это то же самое, что и функция [`dict.setdefault()`](https://python-all.ru/3.6/library/stdtypes.html#dict.setdefault) на уровне Python. Если значение присутствует, она возвращает значение, соответствующее *key*, из словаря *p*. Если ключ отсутствует в словаре, он вставляется со значением *defaultobj* и возвращается *defaultobj*. Эта функция вычисляет хеш-функцию для *key* только один раз, вместо того чтобы вычислять её отдельно для поиска и вставки.9293Новое в версии 3.4.9495#### `PyObject* PyDict_Items(PyObject *p)`9697*Возвращаемое значение: новая ссылка.*9899Возвращает [`PyListObject`](https://python-all.ru/3.6/c-api/list.html#c.PyListObject), содержащий все элементы из словаря.100101#### `PyObject* PyDict_Keys(PyObject *p)`102103*Возвращаемое значение: новая ссылка.*104105Возвращает [`PyListObject`](https://python-all.ru/3.6/c-api/list.html#c.PyListObject), содержащий все ключи из словаря.106107#### `PyObject* PyDict_Values(PyObject *p)`108109*Возвращаемое значение: новая ссылка.*110111Возвращает [`PyListObject`](https://python-all.ru/3.6/c-api/list.html#c.PyListObject), содержащий все значения из словаря *p*.112113#### `Py_ssize_t PyDict_Size(PyObject *p)`114115Возвращает количество элементов в словаре. Это эквивалентно вызову `len(p)` для словаря.116117#### `int PyDict_Next(PyObject *p, Py_ssize_t *ppos, PyObject **pkey, PyObject **pvalue)`118119Проходит по всем парам ключ-значение в словаре *p*. Переменная `Py_ssize_t`, на которую ссылается *ppos*, должна быть инициализирована значением `0` перед первым вызовом этой функции для запуска итерации; функция возвращает true для каждой пары в словаре и false, когда все пары были переданы. Параметры *pkey* и *pvalue* должны указывать на переменные [`PyObject*`](https://python-all.ru/3.6/c-api/structures.html#c.PyObject), в которые будут записаны ключ и значение соответственно, или могут быть *NULL*. Любые ссылки, возвращаемые через них, являются заимствованными. *ppos* не следует изменять во время итерации. Его значение представляет собой смещения во внутренней структуре словаря, и, поскольку структура разреженная, смещения не являются последовательными.120121Например:122123```c124PyObject *key, *value;125Py_ssize_t pos = 0;126127while (PyDict_Next(self->dict, &pos, &key, &value)) {128    /* сделайте что-нибудь интересное со значениями... */129    ...130}131```132133Словарь *p* не должен изменяться во время итерации. Можно безопасно изменять значения ключей при переборе словаря, но только до тех пор, пока набор ключей не меняется. Например:134135```c136PyObject *key, *value;137Py_ssize_t pos = 0;138139while (PyDict_Next(self->dict, &pos, &key, &value)) {140    long i = PyLong_AsLong(value);141    if (i == -1 && PyErr_Occurred()) {142        return -1;143    }144    PyObject *o = PyLong_FromLong(i + 1);145    if (o == NULL)146        return -1;147    if (PyDict_SetItem(self->dict, key, o) < 0) {148        Py_DECREF(o);149        return -1;150    }151    Py_DECREF(o);152}153```154155#### `int PyDict_Merge(PyObject *a, PyObject *b, int override)`156157Перебирает объект отображения *b*, добавляя пары ключ-значение в словарь *a*. *b* может быть словарем или любым объектом, поддерживающим [`PyMapping_Keys()`](https://python-all.ru/3.6/c-api/mapping.html#c.PyMapping_Keys) и [`PyObject_GetItem()`](https://python-all.ru/3.6/c-api/object.html#c.PyObject_GetItem). Если *override* равно true, существующие пары в *a* будут заменены, если найден совпадающий ключ в *b*; в противном случае пары будут добавлены только если нет совпадающего ключа в *a*. Возвращает `0` при успехе или `-1`, если было возбуждено исключение.158159#### `int PyDict_Update(PyObject *a, PyObject *b)`160161То же самое, что и `PyDict_Merge(a, b, 1)` в C, и похоже на `a.update(b)` в Python, за исключением того, что [`PyDict_Update()`](https://python-all.ru/3.6/c-api/dict.html#c.PyDict_Update) не переходит к итерации по последовательности пар ключ-значение, если у второго аргумента нет атрибута “keys”. Возвращает `0` при успехе или `-1`, если было возбуждено исключение.162163#### `int PyDict_MergeFromSeq2(PyObject *a, PyObject *seq2, int override)`164165Обновляет или объединяет словарь *a*, используя пары ключ-значение из *seq2*. *seq2* должен быть итерируемым объектом, который возвращает итерируемые объекты длины 2, рассматриваемые как пары ключ-значение. При повторяющихся ключах последнее значение побеждает, если *override* истинно, иначе первое. Возвращает `0` при успехе или `-1`, если возникло исключение. Эквивалент на Python (за исключением возвращаемого значения):166167```c168def PyDict_MergeFromSeq2(a, seq2, override):169    for key, value in seq2:170        if override or key not in a:171            a[key] = value172```173174#### `int PyDict_ClearFreeList()`175176Очищает список свободных элементов. Возвращает общее количество освобождённых элементов.177178Новое в версии 3.3.179