aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/tools/cython/Cython/Includes/cpython/pycapsule.pxd
diff options
context:
space:
mode:
authorAnton Samokhvalov <pg83@yandex.ru>2022-02-10 16:45:17 +0300
committerDaniil Cherednik <dcherednik@yandex-team.ru>2022-02-10 16:45:17 +0300
commitd3a398281c6fd1d3672036cb2d63f842d2cb28c5 (patch)
treedd4bd3ca0f36b817e96812825ffaf10d645803f2 /contrib/tools/cython/Cython/Includes/cpython/pycapsule.pxd
parent72cb13b4aff9bc9cf22e49251bc8fd143f82538f (diff)
downloadydb-d3a398281c6fd1d3672036cb2d63f842d2cb28c5.tar.gz
Restoring authorship annotation for Anton Samokhvalov <pg83@yandex.ru>. Commit 2 of 2.
Diffstat (limited to 'contrib/tools/cython/Cython/Includes/cpython/pycapsule.pxd')
-rw-r--r--contrib/tools/cython/Cython/Includes/cpython/pycapsule.pxd276
1 files changed, 138 insertions, 138 deletions
diff --git a/contrib/tools/cython/Cython/Includes/cpython/pycapsule.pxd b/contrib/tools/cython/Cython/Includes/cpython/pycapsule.pxd
index a8467ce19a..c3d12c7490 100644
--- a/contrib/tools/cython/Cython/Includes/cpython/pycapsule.pxd
+++ b/contrib/tools/cython/Cython/Includes/cpython/pycapsule.pxd
@@ -1,144 +1,144 @@
-
-# available since Python 3.1!
-
-
-cdef extern from "Python.h":
-
- ctypedef struct PyCapsule_Type
- # This subtype of PyObject represents an opaque value, useful for
- # C extension modules who need to pass an opaque value (as a 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.
-
-
- ctypedef void (*PyCapsule_Destructor)(object o)
- # The type of a destructor callback for a capsule.
- #
- # See PyCapsule_New() for the semantics of PyCapsule_Destructor
- # callbacks.
-
-
- bint PyCapsule_CheckExact(object o)
- # Return true if its argument is a PyCapsule.
-
-
+
+# available since Python 3.1!
+
+
+cdef extern from "Python.h":
+
+ ctypedef struct PyCapsule_Type
+ # This subtype of PyObject represents an opaque value, useful for
+ # C extension modules who need to pass an opaque value (as a 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.
+
+
+ ctypedef void (*PyCapsule_Destructor)(object o)
+ # The type of a destructor callback for a capsule.
+ #
+ # See PyCapsule_New() for the semantics of PyCapsule_Destructor
+ # callbacks.
+
+
+ bint PyCapsule_CheckExact(object o)
+ # Return true if its argument is a PyCapsule.
+
+
object PyCapsule_New(void *pointer, const char *name,
- PyCapsule_Destructor destructor)
- # Return value: New reference.
- #
- # Create a 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
- # PyCapsule_Import().
-
-
+ PyCapsule_Destructor destructor)
+ # Return value: New reference.
+ #
+ # Create a 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
+ # PyCapsule_Import().
+
+
void* PyCapsule_GetPointer(object capsule, const char *name) except? NULL
- # 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 strcmp()
- # to compare capsule names.
-
-
- PyCapsule_Destructor PyCapsule_GetDestructor(object capsule) except? NULL
- # 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 PyCapsule_IsValid()
- # or PyErr_Occurred() to disambiguate.
-
-
+ # 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 strcmp()
+ # to compare capsule names.
+
+
+ PyCapsule_Destructor PyCapsule_GetDestructor(object capsule) except? NULL
+ # 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 PyCapsule_IsValid()
+ # or PyErr_Occurred() to disambiguate.
+
+
const char* PyCapsule_GetName(object capsule) except? NULL
- # 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 PyCapsule_IsValid() or
- # PyErr_Occurred() to disambiguate.
-
-
- void* PyCapsule_GetContext(object capsule) except? NULL
- # 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 PyCapsule_IsValid() or
- # PyErr_Occurred() to disambiguate.
-
-
+ # 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 PyCapsule_IsValid() or
+ # PyErr_Occurred() to disambiguate.
+
+
+ void* PyCapsule_GetContext(object capsule) except? NULL
+ # 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 PyCapsule_IsValid() or
+ # PyErr_Occurred() to disambiguate.
+
+
bint PyCapsule_IsValid(object capsule, const char *name)
- # Determines whether or not capsule is a valid capsule. A valid
- # capsule is non-NULL, passes PyCapsule_CheckExact(), has a
- # non-NULL pointer stored in it, and its internal name matches the
- # name parameter. (See PyCapsule_GetPointer() for information on
- # how capsule names are compared.)
- #
- # In other words, if PyCapsule_IsValid() returns a true value,
- # calls to any of the accessors (any function starting with
- # 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.
-
-
- int PyCapsule_SetPointer(object capsule, void *pointer) except -1
- # 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.
-
-
- int PyCapsule_SetDestructor(object capsule, PyCapsule_Destructor destructor) except -1
- # Set the destructor inside capsule to destructor.
- #
- # Return 0 on success. Return nonzero and set an exception on
- # failure.
-
-
+ # Determines whether or not capsule is a valid capsule. A valid
+ # capsule is non-NULL, passes PyCapsule_CheckExact(), has a
+ # non-NULL pointer stored in it, and its internal name matches the
+ # name parameter. (See PyCapsule_GetPointer() for information on
+ # how capsule names are compared.)
+ #
+ # In other words, if PyCapsule_IsValid() returns a true value,
+ # calls to any of the accessors (any function starting with
+ # 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.
+
+
+ int PyCapsule_SetPointer(object capsule, void *pointer) except -1
+ # 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.
+
+
+ int PyCapsule_SetDestructor(object capsule, PyCapsule_Destructor destructor) except -1
+ # Set the destructor inside capsule to destructor.
+ #
+ # Return 0 on success. Return nonzero and set an exception on
+ # failure.
+
+
int PyCapsule_SetName(object capsule, const char *name) except -1
- # 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.
-
-
- int PyCapsule_SetContext(object capsule, void *context) except -1
- # Set the context pointer inside capsule to context. Return 0 on
- # success. Return nonzero and set an exception on failure.
-
-
+ # 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.
+
+
+ int PyCapsule_SetContext(object capsule, void *context) except -1
+ # Set the context pointer inside capsule to context. Return 0 on
+ # success. Return nonzero and set an exception on failure.
+
+
void* PyCapsule_Import(const char *name, int no_block) except? NULL
- # 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
- # PyImport_ImportModuleNoBlock()). If no_block is false, import
- # the module conventionally (using PyImport_ImportModule()).
- #
- # Return the capsule’s internal pointer on success. On failure,
- # set an exception and return NULL. However, if PyCapsule_Import()
- # failed to import the module, and no_block was true, no exception
- # is set.
-
+ # 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
+ # PyImport_ImportModuleNoBlock()). If no_block is false, import
+ # the module conventionally (using PyImport_ImportModule()).
+ #
+ # Return the capsule’s internal pointer on success. On failure,
+ # set an exception and return NULL. However, if PyCapsule_Import()
+ # failed to import the module, and no_block was true, no exception
+ # is set.
+