390 lines
21 KiB
HTML
390 lines
21 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html lang="en" data-content_root="../">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
<meta property="og:title" content="Sentinel objects" />
|
|
<meta property="og:type" content="website" />
|
|
<meta property="og:url" content="https://docs.python.org/3/c-api/sentinel.html" />
|
|
<meta property="og:site_name" content="Python documentation" />
|
|
<meta property="og:image" content="_static/og-image.png" />
|
|
<meta property="og:image:alt" content="Python documentation" />
|
|
<meta name="theme-color" content="#3776ab">
|
|
<meta property="og:image:width" content="200">
|
|
<meta property="og:image:height" content="200">
|
|
|
|
<title>Sentinel objects — Python 3.15.0 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />
|
|
<link rel="stylesheet" type="text/css" href="../_static/classic.css?v=234b1a7c" />
|
|
<link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=48df1187" />
|
|
<link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=0fc419ee" />
|
|
|
|
<script src="../_static/documentation_options.js?v=0fe728b1"></script>
|
|
<script src="../_static/doctools.js?v=9bcbadda"></script>
|
|
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
|
|
<script src="../_static/sidebar.js"></script>
|
|
|
|
<link rel="search" type="application/opensearchdescription+xml"
|
|
title="Search within Python 3.15.0 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="Frame objects" href="frame.html" />
|
|
<link rel="prev" title="Capsules" href="capsule.html" />
|
|
|
|
|
|
<link rel="canonical" href="https://docs.python.org/3/c-api/sentinel.html">
|
|
|
|
|
|
|
|
|
|
<style>
|
|
@media only screen {
|
|
table.full-width-table {
|
|
width: 100%;
|
|
}
|
|
}
|
|
</style>
|
|
<link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">
|
|
<link rel="shortcut icon" type="image/png" href="../_static/py.svg">
|
|
<script type="text/javascript" src="../_static/copybutton.js"></script>
|
|
<script type="text/javascript" src="../_static/menu.js"></script>
|
|
<script type="text/javascript" src="../_static/search-focus.js"></script>
|
|
<script type="text/javascript" src="../_static/themetoggle.js"></script>
|
|
<script type="text/javascript" src="../_static/rtd_switcher.js"></script>
|
|
<meta name="readthedocs-addons-api-version" content="1">
|
|
|
|
</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">
|
|
<nav class="nav-content" role="navigation">
|
|
<label for="menuToggler" class="toggler__label">
|
|
<span></span>
|
|
</label>
|
|
<span class="nav-items-wrapper">
|
|
<a href="https://www.python.org/" class="nav-logo">
|
|
<img src="../_static/py.svg" alt="Python logo">
|
|
</a>
|
|
<span class="version_switcher_placeholder"></span>
|
|
<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" fill="currentColor" 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"></path>
|
|
</svg>
|
|
<input placeholder="Quick search" aria-label="Quick search" type="search" name="q">
|
|
<input type="submit" value="Go">
|
|
</form>
|
|
</span>
|
|
</nav>
|
|
<div class="menu-wrapper">
|
|
<nav class="menu" role="navigation" aria-label="main navigation">
|
|
<div class="language_switcher_placeholder"></div>
|
|
|
|
<label class="theme-selector-label">
|
|
Theme
|
|
<select class="theme-selector" oninput="activateTheme(this.value)">
|
|
<option value="auto" selected>Auto</option>
|
|
<option value="light">Light</option>
|
|
<option value="dark">Dark</option>
|
|
</select>
|
|
</label>
|
|
<div>
|
|
<h4>Previous topic</h4>
|
|
<p class="topless"><a href="capsule.html"
|
|
title="previous chapter">Capsules</a></p>
|
|
</div>
|
|
<div>
|
|
<h4>Next topic</h4>
|
|
<p class="topless"><a href="frame.html"
|
|
title="next chapter">Frame objects</a></p>
|
|
</div>
|
|
<script>
|
|
document.addEventListener('DOMContentLoaded', () => {
|
|
const title = document.querySelector('meta[property="og:title"]').content;
|
|
const elements = document.querySelectorAll('.improvepage');
|
|
const pageurl = window.location.href.split('?')[0];
|
|
elements.forEach(element => {
|
|
const url = new URL(element.href.split('?')[0].replace("-nojs", ""));
|
|
url.searchParams.set('pagetitle', title);
|
|
url.searchParams.set('pageurl', pageurl);
|
|
url.searchParams.set('pagesource', "c-api/sentinel.rst");
|
|
element.href = url.toString();
|
|
});
|
|
});
|
|
</script>
|
|
<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 class="improvepage" href="../improve-page-nojs.html">Improve this page</a></li>
|
|
<li>
|
|
<a href="https://github.com/python/cpython/blob/3.15/Doc/c-api/sentinel.rst?plain=1"
|
|
rel="nofollow">Show source
|
|
</a>
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="related" role="navigation" aria-label="Related">
|
|
<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="frame.html" title="Frame objects"
|
|
accesskey="N">next</a> |</li>
|
|
<li class="right" >
|
|
<a href="capsule.html" title="Capsules"
|
|
accesskey="P">previous</a> |</li>
|
|
|
|
<li class="root-icon"><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> »</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.15.0 Documentation</a> »
|
|
</li>
|
|
|
|
<li class="nav-item nav-item-1"><a href="index.html" >Python/C API reference manual</a> »</li>
|
|
<li class="nav-item nav-item-2"><a href="concrete.html" accesskey="U">Concrete Objects Layer</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">Sentinel 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="search" name="q" id="search-box">
|
|
<input type="submit" value="Go">
|
|
</form>
|
|
</div>
|
|
|
|
|
</li>
|
|
<li class="right">
|
|
<label class="theme-selector-label">
|
|
Theme
|
|
<select class="theme-selector" oninput="activateTheme(this.value)">
|
|
<option value="auto" selected>Auto</option>
|
|
<option value="light">Light</option>
|
|
<option value="dark">Dark</option>
|
|
</select>
|
|
</label> |</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="document">
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
<div class="body" role="main">
|
|
|
|
<section id="sentinel-objects">
|
|
<span id="sentinelobjects"></span><h1>Sentinel objects<a class="headerlink" href="#sentinel-objects" title="Link to this heading">¶</a></h1>
|
|
<dl class="c var">
|
|
<dt class="sig sig-object c" id="c.PySentinel_Type">
|
|
<a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject"><span class="n"><span class="pre">PyTypeObject</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PySentinel_Type</span></span></span><a class="headerlink" href="#c.PySentinel_Type" title="Link to this definition">¶</a><br /></dt>
|
|
<dd><p>This instance of <a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject"><code class="xref c c-type docutils literal notranslate"><span class="pre">PyTypeObject</span></code></a> represents the Python
|
|
<a class="reference internal" href="../builtins/functions.html#sentinel" title="sentinel"><code class="xref py py-class docutils literal notranslate"><span class="pre">sentinel</span></code></a> type. This is the same object as <code class="xref py py-class docutils literal notranslate"><span class="pre">sentinel</span></code>.</p>
|
|
<div class="versionadded">
|
|
<p><span class="versionmodified added">Added in version 3.15.</span></p>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
<dl class="c function">
|
|
<dt class="sig sig-object c" id="c.PySentinel_Check">
|
|
<span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PySentinel_Check</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">o</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PySentinel_Check" title="Link to this definition">¶</a><br /></dt>
|
|
<dd><p>Return true if <em>o</em> is a <a class="reference internal" href="../builtins/functions.html#sentinel" title="sentinel"><code class="xref py py-class docutils literal notranslate"><span class="pre">sentinel</span></code></a> object or a subtype.
|
|
The <code class="xref py py-class docutils literal notranslate"><span class="pre">sentinel</span></code> type does not currently allow subclasses,
|
|
so this check is exact.
|
|
Future Python versions may choose to allow subtyping.
|
|
This function always succeeds.</p>
|
|
<div class="versionadded">
|
|
<p><span class="versionmodified added">Added in version 3.15.</span></p>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
<dl class="c function">
|
|
<dt class="sig sig-object c" id="c.PySentinel_CheckExact">
|
|
<span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PySentinel_CheckExact</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">o</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PySentinel_CheckExact" title="Link to this definition">¶</a><br /></dt>
|
|
<dd><p>Return true if <em>o</em> is a <a class="reference internal" href="../builtins/functions.html#sentinel" title="sentinel"><code class="xref py py-class docutils literal notranslate"><span class="pre">sentinel</span></code></a> object, but not a subtype.
|
|
The <code class="xref py py-class docutils literal notranslate"><span class="pre">sentinel</span></code> type does not currently allow subclasses.
|
|
Future Python versions may choose to allow subtyping.
|
|
This function always succeeds.</p>
|
|
<div class="versionadded">
|
|
<p><span class="versionmodified added">Added in version 3.15.</span></p>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
<dl class="c function">
|
|
<dt class="sig sig-object c" id="c.PySentinel_New">
|
|
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">PySentinel_New</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">name</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">module_name</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">repr</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PySentinel_New" title="Link to this definition">¶</a><br /></dt>
|
|
<dd><em class="refcount return_new_ref">Return value: New reference.</em><p>Return a new <a class="reference internal" href="../builtins/functions.html#sentinel" title="sentinel"><code class="xref py py-class docutils literal notranslate"><span class="pre">sentinel</span></code></a> object with <a class="reference internal" href="../builtins/functions.html#sentinel.__name__" title="sentinel.__name__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">__name__</span></code></a> set to
|
|
<em>name</em> and <a class="reference internal" href="../builtins/functions.html#sentinel.__module__" title="sentinel.__module__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">__module__</span></code></a> set to <em>module_name</em>.
|
|
<em>name</em> must not be <code class="docutils literal notranslate"><span class="pre">NULL</span></code>. If <em>module_name</em> is <code class="docutils literal notranslate"><span class="pre">NULL</span></code>, <code class="xref py py-attr docutils literal notranslate"><span class="pre">__module__</span></code>
|
|
is set to <code class="docutils literal notranslate"><span class="pre">None</span></code>. If <em>repr</em> is <code class="docutils literal notranslate"><span class="pre">NULL</span></code>, <code class="docutils literal notranslate"><span class="pre">repr()</span></code> returns <code class="xref py py-attr docutils literal notranslate"><span class="pre">__name__</span></code>.
|
|
Return <code class="docutils literal notranslate"><span class="pre">NULL</span></code> with an exception set on failure.</p>
|
|
<p>For pickling to work, <em>module_name</em> must be the name of an importable
|
|
module, and the sentinel must be accessible from that module under a
|
|
path matching <em>name</em>. Pickle treats <em>name</em> as a global variable name
|
|
in <em>module_name</em> (see <a class="reference internal" href="../library/pickle.html#object.__reduce__" title="object.__reduce__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">object.__reduce__()</span></code></a>).</p>
|
|
<div class="versionadded">
|
|
<p><span class="versionmodified added">Added in version 3.15.</span></p>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
</section>
|
|
|
|
|
|
<div class="clearer"></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sphinxsidebar" role="navigation" aria-label="Main">
|
|
<div class="sphinxsidebarwrapper">
|
|
<div>
|
|
<h4>Previous topic</h4>
|
|
<p class="topless"><a href="capsule.html"
|
|
title="previous chapter">Capsules</a></p>
|
|
</div>
|
|
<div>
|
|
<h4>Next topic</h4>
|
|
<p class="topless"><a href="frame.html"
|
|
title="next chapter">Frame objects</a></p>
|
|
</div>
|
|
<script>
|
|
document.addEventListener('DOMContentLoaded', () => {
|
|
const title = document.querySelector('meta[property="og:title"]').content;
|
|
const elements = document.querySelectorAll('.improvepage');
|
|
const pageurl = window.location.href.split('?')[0];
|
|
elements.forEach(element => {
|
|
const url = new URL(element.href.split('?')[0].replace("-nojs", ""));
|
|
url.searchParams.set('pagetitle', title);
|
|
url.searchParams.set('pageurl', pageurl);
|
|
url.searchParams.set('pagesource', "c-api/sentinel.rst");
|
|
element.href = url.toString();
|
|
});
|
|
});
|
|
</script>
|
|
<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 class="improvepage" href="../improve-page-nojs.html">Improve this page</a></li>
|
|
<li>
|
|
<a href="https://github.com/python/cpython/blob/3.15/Doc/c-api/sentinel.rst?plain=1"
|
|
rel="nofollow">Show source
|
|
</a>
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div id="sidebarbutton" title="Collapse sidebar">
|
|
<span>«</span>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="clearer"></div>
|
|
</div>
|
|
<div class="related" role="navigation" aria-label="Related">
|
|
<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="frame.html" title="Frame objects"
|
|
>next</a> |</li>
|
|
<li class="right" >
|
|
<a href="capsule.html" title="Capsules"
|
|
>previous</a> |</li>
|
|
|
|
<li class="root-icon"><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> »</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.15.0 Documentation</a> »
|
|
</li>
|
|
|
|
<li class="nav-item nav-item-1"><a href="index.html" >Python/C API reference manual</a> »</li>
|
|
<li class="nav-item nav-item-2"><a href="concrete.html" >Concrete Objects Layer</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">Sentinel 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="search" name="q" id="search-box">
|
|
<input type="submit" value="Go">
|
|
</form>
|
|
</div>
|
|
|
|
|
</li>
|
|
<li class="right">
|
|
<label class="theme-selector-label">
|
|
Theme
|
|
<select class="theme-selector" oninput="activateTheme(this.value)">
|
|
<option value="auto" selected>Auto</option>
|
|
<option value="light">Light</option>
|
|
<option value="dark">Dark</option>
|
|
</select>
|
|
</label> |</li>
|
|
|
|
</ul>
|
|
</div>
|
|
<div class="footer">
|
|
© <a href="../copyright.html">Copyright</a> 2001 Python Software Foundation.
|
|
<br>
|
|
This page is licensed under the Python Software Foundation License Version 2.
|
|
<br>
|
|
Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
|
|
<br>
|
|
|
|
See <a href="/license.html">History and License</a> for more information.<br>
|
|
|
|
|
|
<br>
|
|
|
|
The Python Software Foundation is a non-profit corporation.
|
|
<a href="https://www.python.org/psf/donations/">Please donate.</a>
|
|
<br>
|
|
<br>
|
|
Last updated on Oct 09, 2026 (11:35 UTC).
|
|
|
|
<a href="/bugs.html">Found a bug</a>?
|
|
|
|
<br>
|
|
|
|
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
|
|
</div>
|
|
|
|
</body>
|
|
</html> |