Set 对象

本节详细介绍了 set 和 frozenset 对象的公共 API。任何未在此处列出的功能最好通过抽象对象协议（包括 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)

如果 p 是 set 对象或其子类型的实例，则返回真。此函数总是成功。

int PyFrozenSet_Check(PyObject *p)

如果 p 是 frozenset 对象或其子类型的实例，则返回真。此函数总是成功。

int PyAnySet_Check(PyObject *p)

如果 p 是 set 对象、 frozenset 对象或其子类型的实例，则返回真。此函数总是成功。

int PySet_CheckExact(PyObject *p)

如果 p 是 set 对象而不是其子类型的实例，则返回真。此函数总是成功。

在 3.10 版本加入。

int PyAnySet_CheckExact(PyObject *p)

如果 p 是 set 对象或 frozenset 对象而不是其子类型的实例，则返回真。此函数总是成功。

int PyFrozenSet_CheckExact(PyObject *p)

如果 p 是 frozenset 对象而不是其子类型的实例，则返回真。此函数总是成功。

PyObject *PySet_New(PyObject *iterable)

返回值: 新引用。 稳定ABI 的一部分。

返回一个新的 set，其中包含 iterable 返回的对象。 iterable 可以为 NULL 以创建一个新的空集合。成功时返回新的集合，失败时返回 NULL。如果 iterable 实际上不可迭代，则引发 TypeError。此构造函数也可用于复制集合（c=set(s)）。

PyObject *PyFrozenSet_New(PyObject *iterable)

返回值: 新引用。 稳定ABI 的一部分。

返回一个新的 frozenset，其中包含 iterable 返回的对象。 iterable 可以为 NULL 以创建一个新的空 frozenset。成功时返回新的集合，失败时返回 NULL。如果 iterable 实际上不可迭代，则引发 TypeError。

以下函数和宏适用于 set 或 frozenset 的实例或其子类型的实例。

Py_ssize_t PySet_Size(PyObject *anyset)

作为 稳定 ABI 的一部分。

返回 set 或 frozenset 对象的长度。等同于 len(anyset)。如果 anyset 不是 set、 frozenset 或其子类型的实例，则引发 SystemError。

Py_ssize_t PySet_GET_SIZE(PyObject *anyset)

PySet_Size() 的宏形式，不带错误检查。

int PySet_Contains(PyObject *anyset, PyObject *key)

作为 稳定 ABI 的一部分。

如果找到，返回 1；如果未找到，返回 0；如果遇到错误，返回 -1。与 Python 的 __contains__() 方法不同，此函数不会自动将不可哈希的集合转换为临时的 frozenset。如果 key 不可哈希，则引发 TypeError。如果 anyset 不是 set、 frozenset 或其子类型的实例，则引发 SystemError。

int PySet_Add(PyObject *set, PyObject *key)

作为 稳定 ABI 的一部分。

将 key 添加到 set 实例。也适用于 frozenset 实例（就像 PyTuple_SetItem() 一样，它可以在新的 frozenset 暴露给其他代码之前用于填充其值）。成功时返回 0，失败时返回 -1。如果 key 不可哈希，则引发 TypeError。如果没有足够的空间增长，则引发 MemoryError。如果 set 不是 set 或其子类型的实例，则引发 SystemError。

以下函数适用于 set 的实例或其子类型，但不适用于 frozenset 的实例或其子类型。

int PySet_Discard(PyObject *set, PyObject *key)

作为 稳定 ABI 的一部分。

如果找到并移除，返回 1；如果未找到（未采取任何操作），返回 0；如果遇到错误，返回 -1。对于缺失的键不引发 KeyError。如果 key 不可哈希，则引发 TypeError。与 Python 的 discard() 方法不同，此函数不会自动将不可哈希的集合转换为临时的 frozenset。如果 set 不是 set 或其子类型的实例，则引发 SystemError。

PyObject *PySet_Pop(PyObject *set)

返回值: 新引用。 稳定ABI 的一部分。

返回 set 中任意对象的新引用，并从 set 中移除该对象。失败时返回 NULL。如果集合为空，则引发 KeyError。如果 set 不是 set 或其子类型的实例，则引发 SystemError。

int PySet_Clear(PyObject *set)

作为 稳定 ABI 的一部分。

清空现有集合的所有元素。成功时返回 0。如果 set 不是 set 或其子类型的实例，则返回 -1 并引发 SystemError。