Объекты множеств

В этом разделе подробно описан публичный API для объектов set и frozenset. Любая функциональность, не указанная ниже, лучше всего доступна с помощью абстрактного протокола объектов (включая PyObject_CallMethod(), PyObject_RichCompareBool(), PyObject_Hash(), PyObject_Repr(), PyObject_IsTrue(), PyObject_Print() и PyObject_GetIter()) или абстрактного числового протокола (включая PyNumber_And(), PyNumber_Subtract(), PyNumber_Or(), PyNumber_Xor(), PyNumber_InPlaceAnd(), PyNumber_InPlaceSubtract(), PyNumber_InPlaceOr() и PyNumber_InPlaceXor()).

type PySetObject

Этот подтип PyObject используется для хранения внутренних данных как для объектов set, так и для объектов frozenset. Он похож на PyDictObject в том, что он имеет фиксированный размер для небольших множеств (похоже на хранение кортежей) и указывает на отдельный блок памяти переменного размера для средних и больших множеств (похоже на хранение списков). Никакие поля этой структуры не следует считать общедоступными, и все они могут быть изменены. Все доступ к ним должно осуществляться через документированный API, а не путём изменения значений в структуре.

PyTypeObject PySet_Type

Часть Стабильной ABI.

Это экземпляр PyTypeObject, представляющий тип Python set.

PyTypeObject PyFrozenSet_Type

Часть Стабильной ABI.

Это экземпляр PyTypeObject, представляющий тип Python frozenset.

Следующие макросы проверки типа работают с указателями на любые объекты Python. Аналогично, функции-конструкторы работают с любыми итерируемыми объектами Python.

int PySet_Check(PyObject *p)

Возвращает true, если p является объектом set или экземпляром подтипа. Эта функция всегда выполняется успешно.

int PyFrozenSet_Check(PyObject *p)

Возвращает true, если p является объектом frozenset или экземпляром подтипа. Эта функция всегда выполняется успешно.

int PyAnySet_Check(PyObject *p)

Возвращает true, если p является объектом set, объектом frozenset или экземпляром подтипа. Эта функция всегда выполняется успешно.

int PySet_CheckExact(PyObject *p)

Возвращает true, если p является объектом set, но не экземпляром подтипа. Эта функция всегда выполняется успешно.

Добавлена в версии 3.10.

int PyAnySet_CheckExact(PyObject *p)

Возвращает true, если p является объектом set или объектом frozenset, но не экземпляром подтипа. Эта функция всегда выполняется успешно.

int PyFrozenSet_CheckExact(PyObject *p)

Возвращает true, если p является объектом frozenset, но не экземпляром подтипа. Эта функция всегда выполняется успешно.

PyObject *PySet_New(PyObject *iterable)

Возвращаемое значение: Новая ссылка. Часть Стабильной ABI.

Возвращает новое множество set, содержащее объекты, возвращаемые из iterable. iterable может быть NULL для создания нового пустого множества. Возвращает новое множество при успехе или NULL при неудаче. Вызывает TypeError, если iterable не является итерируемым. Конструктор также полезен для копирования множества (c=set(s)).

PyObject *PyFrozenSet_New(PyObject *iterable)

Возвращаемое значение: Новая ссылка. Часть Стабильной ABI.

Возвращает новое замороженное множество frozenset, содержащее объекты, возвращаемые из iterable. iterable может быть NULL для создания нового пустого замороженного множества. Возвращает новое множество при успехе или NULL при неудаче. Вызывает TypeError, если iterable не является итерируемым.

Следующие функции и макросы доступны для экземпляров set или frozenset или экземпляров их подтипов.

Py_ssize_t PySet_Size(PyObject *anyset)

Часть Стабильной ABI.

Возвращает длину объекта set или frozenset. Эквивалентно len(anyset). Вызывает PyExc_SystemError если anyset не является set, frozenset или экземпляром подтипа.

Py_ssize_t PySet_GET_SIZE(PyObject *anyset)

Макрокоманда PySet_Size() без проверки ошибок.

int PySet_Contains(PyObject *anyset, PyObject *key)

Часть Стабильной ABI.

Возвращает 1 если найдено, 0 если не найдено и -1 если произошла ошибка. В отличие от метода Python __contains__(), эта функция не автоматически преобразует множества, не имеющие хеш-значения, в временные замороженные множества. Вызывает TypeError если key не имеет хеш-значения. Вызывает PyExc_SystemError если anyset не является set, frozenset или экземпляром подтипа.

int PySet_Add(PyObject *set, PyObject *key)

Часть Стабильного АПИ.

Добавляет ключ в экземпляр set. Также работает с экземплярами frozenset (как и PyTuple_SetItem(), может использоваться для заполнения значений новых frozensets до их экспонирования другому коду). Возвращает 0 при успехе или -1 при ошибке. Вызывает TypeError, если ключ не хешируем. Вызывает MemoryError, если нет места для роста. Вызывает SystemError, если множество не является экземпляром set или его подтипа.

Следующие функции доступны для экземпляров set или его подтипов, но не для экземпляров frozenset или его подтипов.

int PySet_Discard(PyObject *set, PyObject *key)

Часть Стабильного АПИ.

Возвращает 1 если элемент найден и удалён, 0 если элемент не найден (никаких действий не выполнено), и -1 если возникла ошибка. Не вызывает KeyError для отсутствующих ключей. Вызывает TypeError, если ключ не хешируем. В отличие от метода Python discard(), эта функция не автоматически преобразует нехешируемые множества во временные frozensets. Вызывает PyExc_SystemError если множество не является экземпляром set или его подтипа.

PyObject *PySet_Pop(PyObject *set)

Значение возврата: Новая ссылка. Часть Стабильного АПИ.

Возвращает новую ссылку на произвольный объект в множестве и удаляет объект из множества. Возвращает NULL при ошибке. Вызывает KeyError, если множество пустое. Вызывает SystemError, если множество не является экземпляром set или его подтипа.

int PySet_Clear(PyObject *set)

Часть Стабильного АПИ.

Очищает существующее множество от всех элементов.