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 : contextvars.html

<!DOCTYPE html>

<title>Context Variables 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="DateTime Objects" href="datetime.html" />
 <link rel="prev" title="Coroutine Objects" href="coro.html" />
 <link rel="canonical" href="file:///usr/share/doc/python3.10/html/c-api/contextvars.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="coro.html"
 title="previous chapter">Coroutine Objects</a>
 <h4>Next topic</h4>
 <a href="datetime.html"
 title="next chapter">DateTime 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/contextvars.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="datetime.html" title="DateTime Objects"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="coro.html" title="Coroutine 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="">Context Variables Objects</a></li>
 <li class="right">

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="context-variables-objects">
<h1>Context Variables Objects<a class="headerlink" href="#context-variables-objects" title="Permalink to this headline">¶</a></h1>
<div class="versionchanged" id="contextvarsobjects-pointertype-change">
Changed in version 3.7.1: 
<div class="admonition note">
Note
In Python 3.7.1 the signatures of all context variables
C APIs were changed to use <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><code class="xref c c-type docutils literal notranslate">PyObject</code></a> pointers instead
of <a class="reference internal" href="#c.PyContext" title="PyContext"><code class="xref c c-type docutils literal notranslate">PyContext</code></a>, <a class="reference internal" href="#c.PyContextVar" title="PyContextVar"><code class="xref c c-type docutils literal notranslate">PyContextVar</code></a>, and
<a class="reference internal" href="#c.PyContextToken" title="PyContextToken"><code class="xref c c-type docutils literal notranslate">PyContextToken</code></a>, e.g.:
<div class="highlight-c notranslate"><div class="highlight"><pre>// in 3.7.0:
PyContext *PyContext_New(void);

// in 3.7.1+:
PyObject *PyContext_New(void);
</pre></div>
</div>
See <a class="reference external" href="https://bugs.python.org/issue?&#64;action=redirect&amp;bpo=34762">bpo-34762</a> for more details.
</div>
</div>
<div class="versionadded">
New in version 3.7.
</div>
This section details the public C API for the <a class="reference internal" href="../library/contextvars.html#module-contextvars" title="contextvars: Context Variables"><code class="xref py py-mod docutils literal notranslate">contextvars</code></a> module.
<dl class="c type">
<dt class="sig sig-object c" id="c.PyContext">
type PyContext<a class="headerlink" href="#c.PyContext" title="Permalink to this definition">¶</a> </dt>
<dd>The C structure used to represent a <a class="reference internal" href="../library/contextvars.html#contextvars.Context" title="contextvars.Context"><code class="xref py py-class docutils literal notranslate">contextvars.Context</code></a>
object.
</dd></dl>

<dl class="c type">
<dt class="sig sig-object c" id="c.PyContextVar">
type PyContextVar<a class="headerlink" href="#c.PyContextVar" title="Permalink to this definition">¶</a> </dt>
<dd>The C structure used to represent a <a class="reference internal" href="../library/contextvars.html#contextvars.ContextVar" title="contextvars.ContextVar"><code class="xref py py-class docutils literal notranslate">contextvars.ContextVar</code></a>
object.
</dd></dl>

<dl class="c type">
<dt class="sig sig-object c" id="c.PyContextToken">
type PyContextToken<a class="headerlink" href="#c.PyContextToken" title="Permalink to this definition">¶</a> </dt>
<dd>The C structure used to represent a <a class="reference internal" href="../library/contextvars.html#contextvars.Token" title="contextvars.Token"><code class="xref py py-class docutils literal notranslate">contextvars.Token</code></a> object.
</dd></dl>

<dl class="c var">
<dt class="sig sig-object c" id="c.PyContext_Type">
<a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> PyContext_Type<a class="headerlink" href="#c.PyContext_Type" title="Permalink to this definition">¶</a> </dt>
<dd>The type object representing the context type.
</dd></dl>

<dl class="c var">
<dt class="sig sig-object c" id="c.PyContextVar_Type">
<a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> PyContextVar_Type<a class="headerlink" href="#c.PyContextVar_Type" title="Permalink to this definition">¶</a> </dt>
<dd>The type object representing the context variable type.
</dd></dl>

<dl class="c var">
<dt class="sig sig-object c" id="c.PyContextToken_Type">
<a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> PyContextToken_Type<a class="headerlink" href="#c.PyContextToken_Type" title="Permalink to this definition">¶</a> </dt>
<dd>The type object representing the context variable token type.
</dd></dl>

Type-check macros:
<dl class="c function">
<dt class="sig sig-object c" id="c.PyContext_CheckExact">
int PyContext_CheckExact(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyContext_CheckExact" title="Permalink to this definition">¶</a> </dt>
<dd>Return true if o is of type <a class="reference internal" href="#c.PyContext_Type" title="PyContext_Type"><code class="xref c c-data docutils literal notranslate">PyContext_Type</code></a>. o must not be
<code class="docutils literal notranslate">NULL</code>. This function always succeeds.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyContextVar_CheckExact">
int PyContextVar_CheckExact(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyContextVar_CheckExact" title="Permalink to this definition">¶</a> </dt>
<dd>Return true if o is of type <a class="reference internal" href="#c.PyContextVar_Type" title="PyContextVar_Type"><code class="xref c c-data docutils literal notranslate">PyContextVar_Type</code></a>. o must not be
<code class="docutils literal notranslate">NULL</code>. This function always succeeds.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyContextToken_CheckExact">
int PyContextToken_CheckExact(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyContextToken_CheckExact" title="Permalink to this definition">¶</a> </dt>
<dd>Return true if o is of type <a class="reference internal" href="#c.PyContextToken_Type" title="PyContextToken_Type"><code class="xref c c-data docutils literal notranslate">PyContextToken_Type</code></a>.
o must not be <code class="docutils literal notranslate">NULL</code>. This function always succeeds.
</dd></dl>

Context object management functions:
<dl class="c function">
<dt class="sig sig-object c" id="c.PyContext_New">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyContext_New(void)<a class="headerlink" href="#c.PyContext_New" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.Create a new empty context object. Returns <code class="docutils literal notranslate">NULL</code> if an error
has occurred.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyContext_Copy">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyContext_Copy(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *ctx)<a class="headerlink" href="#c.PyContext_Copy" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.Create a shallow copy of the passed ctx context object.
Returns <code class="docutils literal notranslate">NULL</code> if an error has occurred.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyContext_CopyCurrent">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyContext_CopyCurrent(void)<a class="headerlink" href="#c.PyContext_CopyCurrent" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.Create a shallow copy of the current thread context.
Returns <code class="docutils literal notranslate">NULL</code> if an error has occurred.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyContext_Enter">
int PyContext_Enter(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *ctx)<a class="headerlink" href="#c.PyContext_Enter" title="Permalink to this definition">¶</a> </dt>
<dd>Set ctx as the current context for the current thread.
Returns <code class="docutils literal notranslate">0</code> on success, and <code class="docutils literal notranslate">-1</code> on error.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyContext_Exit">
int PyContext_Exit(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *ctx)<a class="headerlink" href="#c.PyContext_Exit" title="Permalink to this definition">¶</a> </dt>
<dd>Deactivate the ctx context and restore the previous context as the
current context for the current thread. Returns <code class="docutils literal notranslate">0</code> on success,
and <code class="docutils literal notranslate">-1</code> on error.
</dd></dl>

Context variable functions:
<dl class="c function">
<dt class="sig sig-object c" id="c.PyContextVar_New">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyContextVar_New(const char *name, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *def)<a class="headerlink" href="#c.PyContextVar_New" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.Create a new <code class="docutils literal notranslate">ContextVar</code> object. The name parameter is used
for introspection and debug purposes. The def parameter specifies
a default value for the context variable, or <code class="docutils literal notranslate">NULL</code> for no default.
If an error has occurred, this function returns <code class="docutils literal notranslate">NULL</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyContextVar_Get">
int PyContextVar_Get(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *var, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *default_value, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> **value)<a class="headerlink" href="#c.PyContextVar_Get" title="Permalink to this definition">¶</a> </dt>
<dd>Get the value of a context variable. Returns <code class="docutils literal notranslate">-1</code> if an error has
occurred during lookup, and <code class="docutils literal notranslate">0</code> if no error occurred, whether or not
a value was found.
If the context variable was found, value will be a pointer to it.
If the context variable was not found, value will point to:
<ul class="simple">
<li>default_value, if not <code class="docutils literal notranslate">NULL</code>;</li>
<li>the default value of var, if not <code class="docutils literal notranslate">NULL</code>;</li>
<li><code class="docutils literal notranslate">NULL</code></li>
</ul>
Except for <code class="docutils literal notranslate">NULL</code>, the function returns a new reference.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyContextVar_Set">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyContextVar_Set(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *var, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *value)<a class="headerlink" href="#c.PyContextVar_Set" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.Set the value of var to value in the current context. Returns
a new token object for this change, or <code class="docutils literal notranslate">NULL</code> if an error has occurred.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyContextVar_Reset">
int PyContextVar_Reset(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *var, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *token)<a class="headerlink" href="#c.PyContextVar_Reset" title="Permalink to this definition">¶</a> </dt>
<dd>Reset the state of the var context variable to that it was in before
<a class="reference internal" href="#c.PyContextVar_Set" title="PyContextVar_Set"><code class="xref c c-func docutils literal notranslate">PyContextVar_Set()</code></a> that returned the token was called.
This function returns <code class="docutils literal notranslate">0</code> on success and <code class="docutils literal notranslate">-1</code> on error.
</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="coro.html"
 title="previous chapter">Coroutine Objects</a>
 <h4>Next topic</h4>
 <a href="datetime.html"
 title="next chapter">DateTime 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/contextvars.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="datetime.html" title="DateTime Objects"
 >next</a> |</li>
 <li class="right" >
 <a href="coro.html" title="Coroutine 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="">Context Variables 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 : contextvars.html