Gecko [ www.foryou-vip.com ]

Name	Size	Permission	Date
abstract.rst	723 B	-rw-r--r--	2024-03-19 22:46
allocation.rst	2.64 KB	-rw-r--r--	2024-03-19 22:46
apiabiversion.rst	2.31 KB	-rw-r--r--	2024-03-19 22:46
arg.rst	30.91 KB	-rw-r--r--	2024-03-19 22:46
bool.rst	1.2 KB	-rw-r--r--	2024-03-19 22:46
buffer.rst	22.47 KB	-rw-r--r--	2024-03-19 22:46
bytearray.rst	2.2 KB	-rw-r--r--	2024-03-19 22:46
bytes.rst	9.24 KB	-rw-r--r--	2024-03-19 22:46
call.rst	16.56 KB	-rw-r--r--	2024-03-19 22:46
capsule.rst	5.68 KB	-rw-r--r--	2024-03-19 22:46
cell.rst	1.94 KB	-rw-r--r--	2024-03-19 22:46
code.rst	2.56 KB	-rw-r--r--	2024-03-19 22:46
codec.rst	5.01 KB	-rw-r--r--	2024-03-19 22:46
complex.rst	4.13 KB	-rw-r--r--	2024-03-19 22:46
concrete.rst	2.03 KB	-rw-r--r--	2024-03-19 22:46
contextvars.rst	4.11 KB	-rw-r--r--	2024-03-19 22:46
conversion.rst	5.39 KB	-rw-r--r--	2024-03-19 22:46
coro.rst	862 B	-rw-r--r--	2024-03-19 22:46
datetime.rst	8.46 KB	-rw-r--r--	2024-03-19 22:46
descriptor.rst	1.08 KB	-rw-r--r--	2024-03-19 22:46
dict.rst	8.51 KB	-rw-r--r--	2024-03-19 22:46
exceptions.rst	49.28 KB	-rw-r--r--	2024-03-19 22:46
file.rst	4.25 KB	-rw-r--r--	2024-03-19 22:46
float.rst	2.27 KB	-rw-r--r--	2024-03-19 22:46
function.rst	3.37 KB	-rw-r--r--	2024-03-19 22:46
gcsupport.rst	8.52 KB	-rw-r--r--	2024-03-19 22:46
gen.rst	1.35 KB	-rw-r--r--	2024-03-19 22:46
import.rst	12.61 KB	-rw-r--r--	2024-03-19 22:46
index.rst	632 B	-rw-r--r--	2024-03-19 22:46
init.rst	69.48 KB	-rw-r--r--	2024-03-19 22:46
init_config.rst	48.17 KB	-rw-r--r--	2024-03-19 22:46
intro.rst	32.23 KB	-rw-r--r--	2024-03-19 22:46
iter.rst	1.98 KB	-rw-r--r--	2024-03-19 22:46
iterator.rst	1.67 KB	-rw-r--r--	2024-03-19 22:46
list.rst	4.61 KB	-rw-r--r--	2024-03-19 22:46
long.rst	10.72 KB	-rw-r--r--	2024-03-19 22:46
mapping.rst	3.47 KB	-rw-r--r--	2024-03-19 22:46
marshal.rst	3.71 KB	-rw-r--r--	2024-03-19 22:46
memory.rst	29.92 KB	-rw-r--r--	2024-03-19 22:46
memoryview.rst	2.32 KB	-rw-r--r--	2024-03-19 22:46
method.rst	2.71 KB	-rw-r--r--	2024-03-19 22:46
module.rst	22.79 KB	-rw-r--r--	2024-03-19 22:46
none.rst	736 B	-rw-r--r--	2024-03-19 22:46
number.rst	10.83 KB	-rw-r--r--	2024-03-19 22:46
objbuffer.rst	2.39 KB	-rw-r--r--	2024-03-19 22:46
object.rst	15.16 KB	-rw-r--r--	2024-03-19 22:46
objimpl.rst	300 B	-rw-r--r--	2024-03-19 22:46
refcounting.rst	4.5 KB	-rw-r--r--	2024-03-19 22:46
reflection.rst	1.96 KB	-rw-r--r--	2024-03-19 22:46
sequence.rst	6.62 KB	-rw-r--r--	2024-03-19 22:46
set.rst	6.22 KB	-rw-r--r--	2024-03-19 22:46
slice.rst	4.47 KB	-rw-r--r--	2024-03-19 22:46
stable.rst	6.44 KB	-rw-r--r--	2024-03-19 22:46
structures.rst	18.59 KB	-rw-r--r--	2024-03-19 22:46
sys.rst	16.48 KB	-rw-r--r--	2024-03-19 22:46
tuple.rst	8.45 KB	-rw-r--r--	2024-03-19 22:46
type.rst	9.86 KB	-rw-r--r--	2024-03-19 22:46
typehints.rst	1.67 KB	-rw-r--r--	2024-03-19 22:46
typeobj.rst	127.01 KB	-rw-r--r--	2024-03-19 22:46
unicode.rst	67.9 KB	-rw-r--r--	2024-03-19 22:46
utilities.rst	410 B	-rw-r--r--	2024-03-19 22:46
veryhigh.rst	15.57 KB	-rw-r--r--	2024-03-19 22:46
weakref.rst	3.03 KB	-rw-r--r--	2024-03-19 22:46

Rename

.. highlight:: c

.. _capsules:

Capsules
--------

.. index:: object: Capsule

Refer to :ref:`using-capsules` for more information on using these objects.

.. versionadded:: 3.1

.. c:type:: PyCapsule

This subtype of :c:type:`PyObject` represents an opaque value, useful for C
   extension modules who need to pass an opaque value (as a :c:expr:`void*`
   pointer) through Python code to other C code.  It is often used to make a C
   function pointer defined in one module available to other modules, so the
   regular import mechanism can be used to access C APIs defined in dynamically
   loaded modules.

.. c:type:: PyCapsule_Destructor

The type of a destructor callback for a capsule.  Defined as::

typedef void (*PyCapsule_Destructor)(PyObject *);

See :c:func:`PyCapsule_New` for the semantics of PyCapsule_Destructor
   callbacks.

.. c:function:: int PyCapsule_CheckExact(PyObject *p)

Return true if its argument is a :c:type:`PyCapsule`.  This function always
   succeeds.

.. c:function:: PyObject* PyCapsule_New(void *pointer, const char *name, PyCapsule_Destructor destructor)

Create a :c:type:`PyCapsule` encapsulating the *pointer*.  The *pointer*
   argument may not be ``NULL``.

On failure, set an exception and return ``NULL``.

The *name* string may either be ``NULL`` or a pointer to a valid C string.  If
   non-``NULL``, this string must outlive the capsule.  (Though it is permitted to
   free it inside the *destructor*.)

If the *destructor* argument is not ``NULL``, it will be called with the
   capsule as its argument when it is destroyed.

If this capsule will be stored as an attribute of a module, the *name* should
   be specified as ``modulename.attributename``.  This will enable other modules
   to import the capsule using :c:func:`PyCapsule_Import`.

.. c:function:: void* PyCapsule_GetPointer(PyObject *capsule, const char *name)

Retrieve the *pointer* stored in the capsule.  On failure, set an exception
   and return ``NULL``.

The *name* parameter must compare exactly to the name stored in the capsule.
   If the name stored in the capsule is ``NULL``, the *name* passed in must also
   be ``NULL``.  Python uses the C function :c:func:`strcmp` to compare capsule
   names.

.. c:function:: PyCapsule_Destructor PyCapsule_GetDestructor(PyObject *capsule)

Return the current destructor stored in the capsule.  On failure, set an
   exception and return ``NULL``.

It is legal for a capsule to have a ``NULL`` destructor.  This makes a ``NULL``
   return code somewhat ambiguous; use :c:func:`PyCapsule_IsValid` or
   :c:func:`PyErr_Occurred` to disambiguate.

.. c:function:: void* PyCapsule_GetContext(PyObject *capsule)

Return the current context stored in the capsule.  On failure, set an
   exception and return ``NULL``.

It is legal for a capsule to have a ``NULL`` context.  This makes a ``NULL``
   return code somewhat ambiguous; use :c:func:`PyCapsule_IsValid` or
   :c:func:`PyErr_Occurred` to disambiguate.

.. c:function:: const char* PyCapsule_GetName(PyObject *capsule)

Return the current name stored in the capsule.  On failure, set an exception
   and return ``NULL``.

It is legal for a capsule to have a ``NULL`` name.  This makes a ``NULL`` return
   code somewhat ambiguous; use :c:func:`PyCapsule_IsValid` or
   :c:func:`PyErr_Occurred` to disambiguate.

.. c:function:: void* PyCapsule_Import(const char *name, int no_block)

Import a pointer to a C object from a capsule attribute in a module.  The
   *name* parameter should specify the full name to the attribute, as in
   ``module.attribute``.  The *name* stored in the capsule must match this
   string exactly.  If *no_block* is true, import the module without blocking
   (using :c:func:`PyImport_ImportModuleNoBlock`).  If *no_block* is false,
   import the module conventionally (using :c:func:`PyImport_ImportModule`).

Return the capsule's internal *pointer* on success.  On failure, set an
   exception and return ``NULL``.

.. c:function:: int PyCapsule_IsValid(PyObject *capsule, const char *name)

Determines whether or not *capsule* is a valid capsule.  A valid capsule is
   non-``NULL``, passes :c:func:`PyCapsule_CheckExact`, has a non-``NULL`` pointer
   stored in it, and its internal name matches the *name* parameter.  (See
   :c:func:`PyCapsule_GetPointer` for information on how capsule names are
   compared.)

In other words, if :c:func:`PyCapsule_IsValid` returns a true value, calls to
   any of the accessors (any function starting with :c:func:`PyCapsule_Get`) are
   guaranteed to succeed.

Return a nonzero value if the object is valid and matches the name passed in.
   Return ``0`` otherwise.  This function will not fail.

.. c:function:: int PyCapsule_SetContext(PyObject *capsule, void *context)

Set the context pointer inside *capsule* to *context*.

Return ``0`` on success.  Return nonzero and set an exception on failure.

.. c:function:: int PyCapsule_SetDestructor(PyObject *capsule, PyCapsule_Destructor destructor)

Set the destructor inside *capsule* to *destructor*.

Return ``0`` on success.  Return nonzero and set an exception on failure.

.. c:function:: int PyCapsule_SetName(PyObject *capsule, const char *name)

Set the name inside *capsule* to *name*.  If non-``NULL``, the name must
   outlive the capsule.  If the previous *name* stored in the capsule was not
   ``NULL``, no attempt is made to free it.

Return ``0`` on success.  Return nonzero and set an exception on failure.

.. c:function:: int PyCapsule_SetPointer(PyObject *capsule, void *pointer)

Set the void pointer inside *capsule* to *pointer*.  The pointer may not be
   ``NULL``.

Return ``0`` on success.  Return nonzero and set an exception on failure.