Gecko [ fernandoquevedodop.com ]

Name	Size	Permission
abstract.rst.txt	723 B	-rw-r--r--
allocation.rst.txt	2.58 KB	-rw-r--r--
apiabiversion.rst.txt	2.31 KB	-rw-r--r--
arg.rst.txt	30.78 KB	-rw-r--r--
bool.rst.txt	1.2 KB	-rw-r--r--
buffer.rst.txt	22.36 KB	-rw-r--r--
bytearray.rst.txt	2.2 KB	-rw-r--r--
bytes.rst.txt	9.2 KB	-rw-r--r--
call.rst.txt	16.56 KB	-rw-r--r--
capsule.rst.txt	5.68 KB	-rw-r--r--
cell.rst.txt	1.94 KB	-rw-r--r--
code.rst.txt	2.56 KB	-rw-r--r--
codec.rst.txt	5.01 KB	-rw-r--r--
complex.rst.txt	4.13 KB	-rw-r--r--
concrete.rst.txt	2.03 KB	-rw-r--r--
contextvars.rst.txt	4.11 KB	-rw-r--r--
conversion.rst.txt	5.39 KB	-rw-r--r--
coro.rst.txt	862 B	-rw-r--r--
datetime.rst.txt	8.46 KB	-rw-r--r--
descriptor.rst.txt	1.08 KB	-rw-r--r--
dict.rst.txt	8.51 KB	-rw-r--r--
exceptions.rst.txt	49.24 KB	-rw-r--r--
file.rst.txt	4.25 KB	-rw-r--r--
float.rst.txt	2.27 KB	-rw-r--r--
function.rst.txt	3.37 KB	-rw-r--r--
gcsupport.rst.txt	8.52 KB	-rw-r--r--
gen.rst.txt	1.35 KB	-rw-r--r--
import.rst.txt	12.61 KB	-rw-r--r--
index.rst.txt	632 B	-rw-r--r--
init.rst.txt	69.48 KB	-rw-r--r--
init_config.rst.txt	48.17 KB	-rw-r--r--
intro.rst.txt	32.03 KB	-rw-r--r--
iter.rst.txt	1.98 KB	-rw-r--r--
iterator.rst.txt	1.67 KB	-rw-r--r--
list.rst.txt	4.61 KB	-rw-r--r--
long.rst.txt	10.72 KB	-rw-r--r--
mapping.rst.txt	3.47 KB	-rw-r--r--
marshal.rst.txt	3.71 KB	-rw-r--r--
memory.rst.txt	29.92 KB	-rw-r--r--
memoryview.rst.txt	2.32 KB	-rw-r--r--
method.rst.txt	2.71 KB	-rw-r--r--
module.rst.txt	22.8 KB	-rw-r--r--
none.rst.txt	736 B	-rw-r--r--
number.rst.txt	10.83 KB	-rw-r--r--
objbuffer.rst.txt	2.39 KB	-rw-r--r--
object.rst.txt	15.14 KB	-rw-r--r--
objimpl.rst.txt	300 B	-rw-r--r--
refcounting.rst.txt	4.18 KB	-rw-r--r--
reflection.rst.txt	1.96 KB	-rw-r--r--
sequence.rst.txt	6.62 KB	-rw-r--r--
set.rst.txt	6.22 KB	-rw-r--r--
slice.rst.txt	4.47 KB	-rw-r--r--
stable.rst.txt	6.44 KB	-rw-r--r--
structures.rst.txt	18.59 KB	-rw-r--r--
sys.rst.txt	16.47 KB	-rw-r--r--
tuple.rst.txt	8.45 KB	-rw-r--r--
type.rst.txt	9.86 KB	-rw-r--r--
typehints.rst.txt	1.67 KB	-rw-r--r--
typeobj.rst.txt	126.97 KB	-rw-r--r--
unicode.rst.txt	67.91 KB	-rw-r--r--
utilities.rst.txt	410 B	-rw-r--r--
veryhigh.rst.txt	15.57 KB	-rw-r--r--
weakref.rst.txt	3.03 KB	-rw-r--r--

Code Editor : contextvars.rst.txt

.. highlight:: c

.. _contextvarsobjects:

Context Variables Objects
-------------------------

.. _contextvarsobjects_pointertype_change:
.. versionchanged:: 3.7.1

.. note::

In Python 3.7.1 the signatures of all context variables
      C APIs were **changed** to use :c:type:`PyObject` pointers instead
      of :c:type:`PyContext`, :c:type:`PyContextVar`, and
      :c:type:`PyContextToken`, e.g.::

// in 3.7.0:
         PyContext *PyContext_New(void);

// in 3.7.1+:
         PyObject *PyContext_New(void);

See :issue:`34762` for more details.

.. versionadded:: 3.7

This section details the public C API for the :mod:`contextvars` module.

.. c:type:: PyContext

The C structure used to represent a :class:`contextvars.Context`
   object.

.. c:type:: PyContextVar

The C structure used to represent a :class:`contextvars.ContextVar`
   object.

.. c:type:: PyContextToken

The C structure used to represent a :class:`contextvars.Token` object.

.. c:var:: PyTypeObject PyContext_Type

The type object representing the *context* type.

.. c:var:: PyTypeObject PyContextVar_Type

The type object representing the *context variable* type.

.. c:var:: PyTypeObject PyContextToken_Type

The type object representing the *context variable token* type.

Type-check macros:

.. c:function:: int PyContext_CheckExact(PyObject *o)

Return true if *o* is of type :c:data:`PyContext_Type`. *o* must not be
   ``NULL``.  This function always succeeds.

.. c:function:: int PyContextVar_CheckExact(PyObject *o)

Return true if *o* is of type :c:data:`PyContextVar_Type`. *o* must not be
   ``NULL``.  This function always succeeds.

.. c:function:: int PyContextToken_CheckExact(PyObject *o)

Return true if *o* is of type :c:data:`PyContextToken_Type`.
   *o* must not be ``NULL``.  This function always succeeds.

Context object management functions:

.. c:function:: PyObject *PyContext_New(void)

Create a new empty context object.  Returns ``NULL`` if an error
   has occurred.

.. c:function:: PyObject *PyContext_Copy(PyObject *ctx)

Create a shallow copy of the passed *ctx* context object.
   Returns ``NULL`` if an error has occurred.

.. c:function:: PyObject *PyContext_CopyCurrent(void)

Create a shallow copy of the current thread context.
   Returns ``NULL`` if an error has occurred.

.. c:function:: int PyContext_Enter(PyObject *ctx)

Set *ctx* as the current context for the current thread.
   Returns ``0`` on success, and ``-1`` on error.

.. c:function:: int PyContext_Exit(PyObject *ctx)

Deactivate the *ctx* context and restore the previous context as the
   current context for the current thread.  Returns ``0`` on success,
   and ``-1`` on error.

Context variable functions:

.. c:function:: PyObject *PyContextVar_New(const char *name, PyObject *def)

Create a new ``ContextVar`` object.  The *name* parameter is used
   for introspection and debug purposes.  The *def* parameter specifies
   a default value for the context variable, or ``NULL`` for no default.
   If an error has occurred, this function returns ``NULL``.

.. c:function:: int PyContextVar_Get(PyObject *var, PyObject *default_value, PyObject **value)

Get the value of a context variable.  Returns ``-1`` if an error has
   occurred during lookup, and ``0`` 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:

- *default_value*, if not ``NULL``;
   - the default value of *var*, if not ``NULL``;
   - ``NULL``

Except for ``NULL``, the function returns a new reference.

.. c:function:: PyObject *PyContextVar_Set(PyObject *var, PyObject *value)

Set the value of *var* to *value* in the current context.  Returns
   a new token object for this change, or ``NULL`` if an error has occurred.

.. c:function:: int PyContextVar_Reset(PyObject *var, PyObject *token)

Reset the state of the *var* context variable to that it was in before
   :c:func:`PyContextVar_Set` that returned the *token* was called.
   This function returns ``0`` on success and ``-1`` on error.

${this.title}

Code Editor : contextvars.rst.txt