Gecko [ satitravel.com ]

Name	Size	Permission	Date
abstract.rst.txt	715 B	-rw-r--r--	2018-10-20 05:24
allocation.rst.txt	2.59 KB	-rw-r--r--	2018-10-20 05:24
apiabiversion.rst.txt	2.19 KB	-rw-r--r--	2018-10-20 05:24
arg.rst.txt	29.93 KB	-rw-r--r--	2018-10-20 05:24
bool.rst.txt	1.17 KB	-rw-r--r--	2018-10-20 05:24
buffer.rst.txt	21.75 KB	-rw-r--r--	2018-10-20 05:24
bytearray.rst.txt	2.2 KB	-rw-r--r--	2018-10-20 05:24
bytes.rst.txt	9 KB	-rw-r--r--	2018-10-20 05:24
capsule.rst.txt	5.61 KB	-rw-r--r--	2018-10-20 05:24
cell.rst.txt	1.89 KB	-rw-r--r--	2018-10-20 05:24
code.rst.txt	1.63 KB	-rw-r--r--	2018-10-20 05:24
codec.rst.txt	4.69 KB	-rw-r--r--	2018-10-20 05:24
complex.rst.txt	3.85 KB	-rw-r--r--	2018-10-20 05:24
concrete.rst.txt	2 KB	-rw-r--r--	2018-10-20 05:24
conversion.rst.txt	5.39 KB	-rw-r--r--	2018-10-20 05:24
coro.rst.txt	820 B	-rw-r--r--	2018-10-20 05:24
datetime.rst.txt	6.26 KB	-rw-r--r--	2018-10-20 05:24
descriptor.rst.txt	1.08 KB	-rw-r--r--	2018-10-20 05:24
dict.rst.txt	7.77 KB	-rw-r--r--	2018-10-20 05:24
exceptions.rst.txt	46.69 KB	-rw-r--r--	2018-10-20 05:24
file.rst.txt	3.17 KB	-rw-r--r--	2018-10-20 05:24
float.rst.txt	2.19 KB	-rw-r--r--	2018-10-20 05:24
function.rst.txt	3.27 KB	-rw-r--r--	2018-10-20 05:24
gcsupport.rst.txt	5.92 KB	-rw-r--r--	2018-10-20 05:24
gen.rst.txt	1.27 KB	-rw-r--r--	2018-10-20 05:24
import.rst.txt	12.52 KB	-rw-r--r--	2018-10-20 05:24
index.rst.txt	613 B	-rw-r--r--	2018-10-20 05:24
init.rst.txt	51.16 KB	-rw-r--r--	2018-10-20 05:24
intro.rst.txt	28.08 KB	-rw-r--r--	2018-10-20 05:24
iter.rst.txt	1.1 KB	-rw-r--r--	2018-10-20 05:24
iterator.rst.txt	1.6 KB	-rw-r--r--	2018-10-20 05:24
list.rst.txt	4.62 KB	-rw-r--r--	2018-10-20 05:24
long.rst.txt	10.19 KB	-rw-r--r--	2018-10-20 05:24
mapping.rst.txt	2.8 KB	-rw-r--r--	2018-10-20 05:24
marshal.rst.txt	3.48 KB	-rw-r--r--	2018-10-20 05:24
memory.rst.txt	20.87 KB	-rw-r--r--	2018-10-20 05:24
memoryview.rst.txt	2.29 KB	-rw-r--r--	2018-10-20 05:24
method.rst.txt	2.75 KB	-rw-r--r--	2018-10-20 05:24
module.rst.txt	17.84 KB	-rw-r--r--	2018-10-20 05:24
none.rst.txt	740 B	-rw-r--r--	2018-10-20 05:24
number.rst.txt	10.33 KB	-rw-r--r--	2018-10-20 05:24
objbuffer.rst.txt	2.15 KB	-rw-r--r--	2018-10-20 05:24
object.rst.txt	17.01 KB	-rw-r--r--	2018-10-20 05:24
objimpl.rst.txt	304 B	-rw-r--r--	2018-10-20 05:24
refcounting.rst.txt	2.84 KB	-rw-r--r--	2018-10-20 05:24
reflection.rst.txt	1.38 KB	-rw-r--r--	2018-10-20 05:24
sequence.rst.txt	6.39 KB	-rw-r--r--	2018-10-20 05:24
set.rst.txt	6 KB	-rw-r--r--	2018-10-20 05:24
slice.rst.txt	2.35 KB	-rw-r--r--	2018-10-20 05:24
stable.rst.txt	1.92 KB	-rw-r--r--	2018-10-20 05:24
structures.rst.txt	13.46 KB	-rw-r--r--	2018-10-20 05:24
sys.rst.txt	9.71 KB	-rw-r--r--	2018-10-20 05:24
tuple.rst.txt	7.84 KB	-rw-r--r--	2018-10-20 05:24
type.rst.txt	3.87 KB	-rw-r--r--	2018-10-20 05:24
typeobj.rst.txt	58.77 KB	-rw-r--r--	2018-10-20 05:24
unicode.rst.txt	66.48 KB	-rw-r--r--	2018-10-20 05:24
utilities.rst.txt	414 B	-rw-r--r--	2018-10-20 05:24
veryhigh.rst.txt	16.26 KB	-rw-r--r--	2018-10-20 05:24
weakref.rst.txt	2.57 KB	-rw-r--r--	2018-10-20 05:24

Rename

.. highlightlang:: 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:type:`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`.

.. 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.