Gecko [ fernandoquevedodop.com ]

Name	Size	Permission
abstract.html	13.46 KB	-rw-r--r--
allocation.html	21.28 KB	-rw-r--r--
apiabiversion.html	15.83 KB	-rw-r--r--
arg.html	105.47 KB	-rw-r--r--
bool.html	14.58 KB	-rw-r--r--
buffer.html	83.05 KB	-rw-r--r--
bytearray.html	24.02 KB	-rw-r--r--
bytes.html	38.82 KB	-rw-r--r--
call.html	64.15 KB	-rw-r--r--
capsule.html	33.48 KB	-rw-r--r--
cell.html	17.69 KB	-rw-r--r--
code.html	24.99 KB	-rw-r--r--
codec.html	39.51 KB	-rw-r--r--
complex.html	30.48 KB	-rw-r--r--
concrete.html	21.41 KB	-rw-r--r--
contextvars.html	30.26 KB	-rw-r--r--
conversion.html	28.6 KB	-rw-r--r--
coro.html	14.01 KB	-rw-r--r--
datetime.html	53.09 KB	-rw-r--r--
descriptor.html	19.49 KB	-rw-r--r--
dict.html	56.11 KB	-rw-r--r--
exceptions.html	190.81 KB	-rw-r--r--
file.html	24.95 KB	-rw-r--r--
float.html	21.84 KB	-rw-r--r--
function.html	27.12 KB	-rw-r--r--
gcsupport.html	43.43 KB	-rw-r--r--
gen.html	16.21 KB	-rw-r--r--
import.html	61.83 KB	-rw-r--r--
index.html	22.24 KB	-rw-r--r--
init.html	225.02 KB	-rw-r--r--
init_config.html	204.18 KB	-rw-r--r--
intro.html	96.61 KB	-rw-r--r--
iter.html	19.62 KB	-rw-r--r--
iterator.html	16.87 KB	-rw-r--r--
list.html	34.91 KB	-rw-r--r--
long.html	62.14 KB	-rw-r--r--
mapping.html	28.43 KB	-rw-r--r--
marshal.html	23.89 KB	-rw-r--r--
memory.html	95.91 KB	-rw-r--r--
memoryview.html	20 KB	-rw-r--r--
method.html	23.98 KB	-rw-r--r--
module.html	98.3 KB	-rw-r--r--
none.html	12.1 KB	-rw-r--r--
number.html	74.63 KB	-rw-r--r--
objbuffer.html	19.12 KB	-rw-r--r--
object.html	80.93 KB	-rw-r--r--
objimpl.html	13.03 KB	-rw-r--r--
refcounting.html	25.62 KB	-rw-r--r--
reflection.html	20.69 KB	-rw-r--r--
sequence.html	46.94 KB	-rw-r--r--
set.html	41.5 KB	-rw-r--r--
slice.html	30.93 KB	-rw-r--r--
stable.html	195.79 KB	-rw-r--r--
structures.html	73.73 KB	-rw-r--r--
sys.html	69.43 KB	-rw-r--r--
tuple.html	47.5 KB	-rw-r--r--
type.html	55.03 KB	-rw-r--r--
typehints.html	16.62 KB	-rw-r--r--
typeobj.html	428.4 KB	-rw-r--r--
unicode.html	287.18 KB	-rw-r--r--
utilities.html	11.88 KB	-rw-r--r--
veryhigh.html	81.69 KB	-rw-r--r--
weakref.html	21.05 KB	-rw-r--r--

Code Editor : set.html

<!DOCTYPE html>

<title>Set Objects &#8212; Python 3.10.12 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
 
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?2022.1" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 3.10.12 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="Function Objects" href="function.html" />
 <link rel="prev" title="Dictionary Objects" href="dict.html" />
 <link rel="canonical" href="file:///usr/share/doc/python3.10/html/c-api/set.html" />

</head>
<body>
<div class="mobile-nav">
 <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
 aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />
 <label for="menuToggler" class="toggler__label">
 
 </label>
 <nav class="nav-content" role="navigation">
 <a href="https://www.python.org/" class="nav-logo">
 <img src="../_static/py.svg" alt="Logo"/>
 </a>
 <div class="version_switcher_placeholder"></div>
 <form role="search" class="search" action="../search.html" method="get">
 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
 <path fill-rule="nonzero"
 d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z" fill="#444"></path>
 </svg>
 <input type="text" name="q" aria-label="Quick search"/>
 <input type="submit" value="Go"/>
 </form>
 </nav>
 <div class="menu-wrapper">
 <nav class="menu" role="navigation" aria-label="main navigation">
 <div class="language_switcher_placeholder"></div>
 <h4>Previous topic</h4>
 <a href="dict.html"
 title="previous chapter">Dictionary Objects</a>
 <h4>Next topic</h4>
 <a href="function.html"
 title="next chapter">Function Objects</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../bugs.html">Report a Bug</a></li>
 <li>
 <a href="https://github.com/python/cpython/blob/3.10/Doc/c-api/set.rst"
 rel="nofollow">Show Source
 </a>
 </li>
 </ul>
 </div>
 </nav>
 </div>
</div>

<div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="function.html" title="Function Objects"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="dict.html" title="Dictionary Objects"
 accesskey="P">previous</a> |</li>

<li><img src="../_static/py.svg" alt="python logo" style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li class="switchers">
 <div class="language_switcher_placeholder"></div>
 <div class="version_switcher_placeholder"></div>
 </li>
 <li>
 
 </li>
 <li id="cpython-language-and-version">
 <a href="../index.html">3.10.12 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="concrete.html" accesskey="U">Concrete Objects Layer</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">Set Objects</a></li>
 <li class="right">

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="set-objects">
<h1>Set Objects<a class="headerlink" href="#set-objects" title="Permalink to this headline">¶</a></h1>
This section details the public API for <a class="reference internal" href="../library/stdtypes.html#set" title="set"><code class="xref py py-class docutils literal notranslate">set</code></a> and <a class="reference internal" href="../library/stdtypes.html#frozenset" title="frozenset"><code class="xref py py-class docutils literal notranslate">frozenset</code></a>
objects. Any functionality not listed below is best accessed using either
the abstract object protocol (including <a class="reference internal" href="call.html#c.PyObject_CallMethod" title="PyObject_CallMethod"><code class="xref c c-func docutils literal notranslate">PyObject_CallMethod()</code></a>,
<a class="reference internal" href="object.html#c.PyObject_RichCompareBool" title="PyObject_RichCompareBool"><code class="xref c c-func docutils literal notranslate">PyObject_RichCompareBool()</code></a>, <a class="reference internal" href="object.html#c.PyObject_Hash" title="PyObject_Hash"><code class="xref c c-func docutils literal notranslate">PyObject_Hash()</code></a>,
<a class="reference internal" href="object.html#c.PyObject_Repr" title="PyObject_Repr"><code class="xref c c-func docutils literal notranslate">PyObject_Repr()</code></a>, <a class="reference internal" href="object.html#c.PyObject_IsTrue" title="PyObject_IsTrue"><code class="xref c c-func docutils literal notranslate">PyObject_IsTrue()</code></a>, <a class="reference internal" href="object.html#c.PyObject_Print" title="PyObject_Print"><code class="xref c c-func docutils literal notranslate">PyObject_Print()</code></a>, and
<a class="reference internal" href="object.html#c.PyObject_GetIter" title="PyObject_GetIter"><code class="xref c c-func docutils literal notranslate">PyObject_GetIter()</code></a>) or the abstract number protocol (including
<a class="reference internal" href="number.html#c.PyNumber_And" title="PyNumber_And"><code class="xref c c-func docutils literal notranslate">PyNumber_And()</code></a>, <a class="reference internal" href="number.html#c.PyNumber_Subtract" title="PyNumber_Subtract"><code class="xref c c-func docutils literal notranslate">PyNumber_Subtract()</code></a>, <a class="reference internal" href="number.html#c.PyNumber_Or" title="PyNumber_Or"><code class="xref c c-func docutils literal notranslate">PyNumber_Or()</code></a>,
<a class="reference internal" href="number.html#c.PyNumber_Xor" title="PyNumber_Xor"><code class="xref c c-func docutils literal notranslate">PyNumber_Xor()</code></a>, <a class="reference internal" href="number.html#c.PyNumber_InPlaceAnd" title="PyNumber_InPlaceAnd"><code class="xref c c-func docutils literal notranslate">PyNumber_InPlaceAnd()</code></a>,
<a class="reference internal" href="number.html#c.PyNumber_InPlaceSubtract" title="PyNumber_InPlaceSubtract"><code class="xref c c-func docutils literal notranslate">PyNumber_InPlaceSubtract()</code></a>, <a class="reference internal" href="number.html#c.PyNumber_InPlaceOr" title="PyNumber_InPlaceOr"><code class="xref c c-func docutils literal notranslate">PyNumber_InPlaceOr()</code></a>, and
<a class="reference internal" href="number.html#c.PyNumber_InPlaceXor" title="PyNumber_InPlaceXor"><code class="xref c c-func docutils literal notranslate">PyNumber_InPlaceXor()</code></a>).
<dl class="c type">
<dt class="sig sig-object c" id="c.PySetObject">
type PySetObject<a class="headerlink" href="#c.PySetObject" title="Permalink to this definition">¶</a> </dt>
<dd>This subtype of <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><code class="xref c c-type docutils literal notranslate">PyObject</code></a> is used to hold the internal data for both
<a class="reference internal" href="../library/stdtypes.html#set" title="set"><code class="xref py py-class docutils literal notranslate">set</code></a> and <a class="reference internal" href="../library/stdtypes.html#frozenset" title="frozenset"><code class="xref py py-class docutils literal notranslate">frozenset</code></a> objects. It is like a <a class="reference internal" href="dict.html#c.PyDictObject" title="PyDictObject"><code class="xref c c-type docutils literal notranslate">PyDictObject</code></a>
in that it is a fixed size for small sets (much like tuple storage) and will
point to a separate, variable sized block of memory for medium and large sized
sets (much like list storage). None of the fields of this structure should be
considered public and all are subject to change. All access should be done through
the documented API rather than by manipulating the values in the structure.
</dd></dl>

<dl class="c var">
<dt class="sig sig-object c" id="c.PySet_Type">
<a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> PySet_Type<a class="headerlink" href="#c.PySet_Type" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.This is an instance of <a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject"><code class="xref c c-type docutils literal notranslate">PyTypeObject</code></a> representing the Python
<a class="reference internal" href="../library/stdtypes.html#set" title="set"><code class="xref py py-class docutils literal notranslate">set</code></a> type.
</dd></dl>

<dl class="c var">
<dt class="sig sig-object c" id="c.PyFrozenSet_Type">
<a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> PyFrozenSet_Type<a class="headerlink" href="#c.PyFrozenSet_Type" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.This is an instance of <a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject"><code class="xref c c-type docutils literal notranslate">PyTypeObject</code></a> representing the Python
<a class="reference internal" href="../library/stdtypes.html#frozenset" title="frozenset"><code class="xref py py-class docutils literal notranslate">frozenset</code></a> type.
</dd></dl>

The following type check macros work on pointers to any Python object. Likewise,
the constructor functions work with any iterable Python object.
<dl class="c function">
<dt class="sig sig-object c" id="c.PySet_Check">
int PySet_Check(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *p)<a class="headerlink" href="#c.PySet_Check" title="Permalink to this definition">¶</a> </dt>
<dd>Return true if p is a <a class="reference internal" href="../library/stdtypes.html#set" title="set"><code class="xref py py-class docutils literal notranslate">set</code></a> object or an instance of a subtype.
This function always succeeds.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyFrozenSet_Check">
int PyFrozenSet_Check(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *p)<a class="headerlink" href="#c.PyFrozenSet_Check" title="Permalink to this definition">¶</a> </dt>
<dd>Return true if p is a <a class="reference internal" href="../library/stdtypes.html#frozenset" title="frozenset"><code class="xref py py-class docutils literal notranslate">frozenset</code></a> object or an instance of a
subtype. This function always succeeds.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyAnySet_Check">
int PyAnySet_Check(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *p)<a class="headerlink" href="#c.PyAnySet_Check" title="Permalink to this definition">¶</a> </dt>
<dd>Return true if p is a <a class="reference internal" href="../library/stdtypes.html#set" title="set"><code class="xref py py-class docutils literal notranslate">set</code></a> object, a <a class="reference internal" href="../library/stdtypes.html#frozenset" title="frozenset"><code class="xref py py-class docutils literal notranslate">frozenset</code></a> object, or an
instance of a subtype. This function always succeeds.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PySet_CheckExact">
int PySet_CheckExact(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *p)<a class="headerlink" href="#c.PySet_CheckExact" title="Permalink to this definition">¶</a> </dt>
<dd>Return true if p is a <a class="reference internal" href="../library/stdtypes.html#set" title="set"><code class="xref py py-class docutils literal notranslate">set</code></a> object but not an instance of a
subtype. This function always succeeds.
<div class="versionadded">
New in version 3.10.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyAnySet_CheckExact">
int PyAnySet_CheckExact(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *p)<a class="headerlink" href="#c.PyAnySet_CheckExact" title="Permalink to this definition">¶</a> </dt>
<dd>Return true if p is a <a class="reference internal" href="../library/stdtypes.html#set" title="set"><code class="xref py py-class docutils literal notranslate">set</code></a> object or a <a class="reference internal" href="../library/stdtypes.html#frozenset" title="frozenset"><code class="xref py py-class docutils literal notranslate">frozenset</code></a> object but
not an instance of a subtype. This function always succeeds.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyFrozenSet_CheckExact">
int PyFrozenSet_CheckExact(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *p)<a class="headerlink" href="#c.PyFrozenSet_CheckExact" title="Permalink to this definition">¶</a> </dt>
<dd>Return true if p is a <a class="reference internal" href="../library/stdtypes.html#frozenset" title="frozenset"><code class="xref py py-class docutils literal notranslate">frozenset</code></a> object but not an instance of a
subtype. This function always succeeds.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PySet_New">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PySet_New(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *iterable)<a class="headerlink" href="#c.PySet_New" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Return a new <a class="reference internal" href="../library/stdtypes.html#set" title="set"><code class="xref py py-class docutils literal notranslate">set</code></a> containing objects returned by the iterable. The
iterable may be <code class="docutils literal notranslate">NULL</code> to create a new empty set. Return the new set on
success or <code class="docutils literal notranslate">NULL</code> on failure. Raise <a class="reference internal" href="../library/exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate">TypeError</code></a> if iterable is not
actually iterable. The constructor is also useful for copying a set
(<code class="docutils literal notranslate">c=set(s)</code>).
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyFrozenSet_New">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyFrozenSet_New(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *iterable)<a class="headerlink" href="#c.PyFrozenSet_New" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Return a new <a class="reference internal" href="../library/stdtypes.html#frozenset" title="frozenset"><code class="xref py py-class docutils literal notranslate">frozenset</code></a> containing objects returned by the iterable.
The iterable may be <code class="docutils literal notranslate">NULL</code> to create a new empty frozenset. Return the new
set on success or <code class="docutils literal notranslate">NULL</code> on failure. Raise <a class="reference internal" href="../library/exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate">TypeError</code></a> if iterable is
not actually iterable.
</dd></dl>

The following functions and macros are available for instances of <a class="reference internal" href="../library/stdtypes.html#set" title="set"><code class="xref py py-class docutils literal notranslate">set</code></a>
or <a class="reference internal" href="../library/stdtypes.html#frozenset" title="frozenset"><code class="xref py py-class docutils literal notranslate">frozenset</code></a> or instances of their subtypes.
<dl class="c function">
<dt class="sig sig-object c" id="c.PySet_Size">
<a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> PySet_Size(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *anyset)<a class="headerlink" href="#c.PySet_Size" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Return the length of a <a class="reference internal" href="../library/stdtypes.html#set" title="set"><code class="xref py py-class docutils literal notranslate">set</code></a> or <a class="reference internal" href="../library/stdtypes.html#frozenset" title="frozenset"><code class="xref py py-class docutils literal notranslate">frozenset</code></a> object. Equivalent to
<code class="docutils literal notranslate">len(anyset)</code>. Raises a <code class="xref py py-exc docutils literal notranslate">PyExc_SystemError</code> if anyset is not a
<a class="reference internal" href="../library/stdtypes.html#set" title="set"><code class="xref py py-class docutils literal notranslate">set</code></a>, <a class="reference internal" href="../library/stdtypes.html#frozenset" title="frozenset"><code class="xref py py-class docutils literal notranslate">frozenset</code></a>, or an instance of a subtype.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PySet_GET_SIZE">
<a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> PySet_GET_SIZE(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *anyset)<a class="headerlink" href="#c.PySet_GET_SIZE" title="Permalink to this definition">¶</a> </dt>
<dd>Macro form of <a class="reference internal" href="#c.PySet_Size" title="PySet_Size"><code class="xref c c-func docutils literal notranslate">PySet_Size()</code></a> without error checking.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PySet_Contains">
int PySet_Contains(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *anyset, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *key)<a class="headerlink" href="#c.PySet_Contains" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Return <code class="docutils literal notranslate">1</code> if found, <code class="docutils literal notranslate">0</code> if not found, and <code class="docutils literal notranslate">-1</code> if an error is encountered. Unlike
the Python <code class="xref py py-meth docutils literal notranslate">__contains__()</code> method, this function does not automatically
convert unhashable sets into temporary frozensets. Raise a <a class="reference internal" href="../library/exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate">TypeError</code></a> if
the key is unhashable. Raise <code class="xref py py-exc docutils literal notranslate">PyExc_SystemError</code> if anyset is not a
<a class="reference internal" href="../library/stdtypes.html#set" title="set"><code class="xref py py-class docutils literal notranslate">set</code></a>, <a class="reference internal" href="../library/stdtypes.html#frozenset" title="frozenset"><code class="xref py py-class docutils literal notranslate">frozenset</code></a>, or an instance of a subtype.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PySet_Add">
int PySet_Add(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *set, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *key)<a class="headerlink" href="#c.PySet_Add" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Add key to a <a class="reference internal" href="../library/stdtypes.html#set" title="set"><code class="xref py py-class docutils literal notranslate">set</code></a> instance. Also works with <a class="reference internal" href="../library/stdtypes.html#frozenset" title="frozenset"><code class="xref py py-class docutils literal notranslate">frozenset</code></a>
instances (like <a class="reference internal" href="tuple.html#c.PyTuple_SetItem" title="PyTuple_SetItem"><code class="xref c c-func docutils literal notranslate">PyTuple_SetItem()</code></a> it can be used to fill in the values
of brand new frozensets before they are exposed to other code). Return <code class="docutils literal notranslate">0</code> on
success or <code class="docutils literal notranslate">-1</code> on failure. Raise a <a class="reference internal" href="../library/exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate">TypeError</code></a> if the key is
unhashable. Raise a <a class="reference internal" href="../library/exceptions.html#MemoryError" title="MemoryError"><code class="xref py py-exc docutils literal notranslate">MemoryError</code></a> if there is no room to grow. Raise a
<a class="reference internal" href="../library/exceptions.html#SystemError" title="SystemError"><code class="xref py py-exc docutils literal notranslate">SystemError</code></a> if set is not an instance of <a class="reference internal" href="../library/stdtypes.html#set" title="set"><code class="xref py py-class docutils literal notranslate">set</code></a> or its
subtype.
</dd></dl>

The following functions are available for instances of <a class="reference internal" href="../library/stdtypes.html#set" title="set"><code class="xref py py-class docutils literal notranslate">set</code></a> or its
subtypes but not for instances of <a class="reference internal" href="../library/stdtypes.html#frozenset" title="frozenset"><code class="xref py py-class docutils literal notranslate">frozenset</code></a> or its subtypes.
<dl class="c function">
<dt class="sig sig-object c" id="c.PySet_Discard">
int PySet_Discard(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *set, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *key)<a class="headerlink" href="#c.PySet_Discard" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Return <code class="docutils literal notranslate">1</code> if found and removed, <code class="docutils literal notranslate">0</code> if not found (no action taken), and <code class="docutils literal notranslate">-1</code> if an
error is encountered. Does not raise <a class="reference internal" href="../library/exceptions.html#KeyError" title="KeyError"><code class="xref py py-exc docutils literal notranslate">KeyError</code></a> for missing keys. Raise a
<a class="reference internal" href="../library/exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate">TypeError</code></a> if the key is unhashable. Unlike the Python <code class="xref py py-meth docutils literal notranslate">discard()</code>
method, this function does not automatically convert unhashable sets into
temporary frozensets. Raise <code class="xref py py-exc docutils literal notranslate">PyExc_SystemError</code> if set is not an
instance of <a class="reference internal" href="../library/stdtypes.html#set" title="set"><code class="xref py py-class docutils literal notranslate">set</code></a> or its subtype.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PySet_Pop">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PySet_Pop(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *set)<a class="headerlink" href="#c.PySet_Pop" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Return a new reference to an arbitrary object in the set, and removes the
object from the set. Return <code class="docutils literal notranslate">NULL</code> on failure. Raise <a class="reference internal" href="../library/exceptions.html#KeyError" title="KeyError"><code class="xref py py-exc docutils literal notranslate">KeyError</code></a> if the
set is empty. Raise a <a class="reference internal" href="../library/exceptions.html#SystemError" title="SystemError"><code class="xref py py-exc docutils literal notranslate">SystemError</code></a> if set is not an instance of
<a class="reference internal" href="../library/stdtypes.html#set" title="set"><code class="xref py py-class docutils literal notranslate">set</code></a> or its subtype.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PySet_Clear">
int PySet_Clear(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *set)<a class="headerlink" href="#c.PySet_Clear" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Empty an existing set of all elements.
</dd></dl>

</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h4>Previous topic</h4>
 <a href="dict.html"
 title="previous chapter">Dictionary Objects</a>
 <h4>Next topic</h4>
 <a href="function.html"
 title="next chapter">Function Objects</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../bugs.html">Report a Bug</a></li>
 <li>
 <a href="https://github.com/python/cpython/blob/3.10/Doc/c-api/set.rst"
 rel="nofollow">Show Source
 </a>
 </li>
 </ul>
 </div>
 </div>
 </div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="function.html" title="Function Objects"
 >next</a> |</li>
 <li class="right" >
 <a href="dict.html" title="Dictionary Objects"
 >previous</a> |</li>

<li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="concrete.html" >Concrete Objects Layer</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">Set Objects</a></li>
 <li class="right">

<div class="inline-search" role="search">
 <form class="inline-search" action="../search.html" method="get">
 <input placeholder="Quick search" aria-label="Quick search" type="text" name="q" />
 <input type="submit" value="Go" />
 <input type="hidden" name="check_keywords" value="yes" />
 <input type="hidden" name="area" value="default" />
 </form>
 </div>
 |
 </li>
 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 2001-2026, Python Software Foundation.
 
 This page is licensed under the Python Software Foundation License Version 2.
 
 Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
 
 See <a href="/license.html">History and License</a> for more information.

The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>

Last updated on January 26, 2026.
 <a href="/bugs.html">Found a bug</a>?

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>

${this.title}

Code Editor : set.html