gh-76595: Add note on PyCapsule_Import behavior (GH-134022)

This commit is contained in:
Nicolas Trangez 2025-06-28 15:01:41 +02:00 committed by GitHub
parent 42ccac2d7f
commit 579acf4562
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -105,9 +105,19 @@ Refer to :ref:`using-capsules` for more information on using these objects.
``module.attribute``. The *name* stored in the capsule must match this
string exactly.
This function splits *name* on the ``.`` character, and imports the first
element. It then processes further elements using attribute lookups.
Return the capsule's internal *pointer* on success. On failure, set an
exception and return ``NULL``.
.. note::
If *name* points to an attribute of some submodule or subpackage, this
submodule or subpackage must be previously imported using other means
(for example, by using :c:func:`PyImport_ImportModule`) for the
attribute lookups to succeed.
.. versionchanged:: 3.3
*no_block* has no effect anymore.