Skip to content

gh-76595: Add note on PyCapsule_Import behavior #134022

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions Doc/c-api/capsule.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Loading