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 1 commit into
base: main
Choose a base branch
from

Conversation

NicolasT
Copy link
Contributor

@NicolasT NicolasT commented May 14, 2025

I was somewhat surprised by this behavior recently, so thought it'd be useful to have a note in the docs.

There's a PR (GH-6898) which changes this behavior (to be less surprising, I believe), but this seems to have stalled.

See: #76595
See: #6898


📚 Documentation preview 📚: https://cpython-previews--134022.org.readthedocs.build/en/134022/c-api/capsule.html#c.PyCapsule_Import

There's a PR (pythonGH-6898) which changes this behavior (to be less
surprising, I believe), but this seems to have stalled.

See: python#76595
See: python#6898
Copy link
Member

@ZeroIntensity ZeroIntensity left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should split up the note. The behavior regarding attribute lookups should go in the canonical description of the function, and then the gotcha about imports should be in the note.

@@ -108,6 +108,14 @@ Refer to :ref:`using-capsules` for more information on using these objects.
Return the capsule's internal *pointer* on success. On failure, set an
exception and return ``NULL``.

.. note::

:c:func:`PyCapsule_Import` splits *name* on the ``.`` character, and
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We already know that it's PyCapsule_Import:

Suggested change
:c:func:`PyCapsule_Import` splits *name* on the ``.`` character, and
This function splits *name* on the ``.`` character, and

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting review docs Documentation in the Doc dir needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes skip news topic-C-API
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

2 participants