Skip to content

Document __pyx_capi__ #6484

Closed as not planned
Closed as not planned

Description

@matusvalo

Describe your issue

__pyx_capi__ seems to be used in other projects, so it became defacto API of cython[1][2]. Currently it is only mentioned in FAQ [3]. It seems to be important for the clients (see #3077 (comment)) and there is no definition of stability of this API. So I propose:

  1. Document __pyx_capi__ since it is already an API used by other projects
  2. Define the rules of the stability - e.g. we guarantee that it will be changed with deprecation period and migration strategy.

[1] https://github.com/ashwinvis/cython_capi
[2] https://github.com/numba/numba/blob/0f363d1b2dd19f2aa1a8cec5f0a99c3dd95512f8/numba/_helperlib.c#L570
[3] https://cython.readthedocs.io/en/latest/src/userguide/faq.html#how-do-i-compile-cython-with-subpackages

Activity

  1. scoder commented on Oct 7, 2025

    @scoder
    Contributor

    Rejected in #3077 (comment) and #3077 (comment)

    While unlikely to change in major ways, we shouldn't actively push users into this by publicly documenting it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions