Skip to content

gh-108494: Argument Clinic: Document how to generate code that uses the limited C API #108584

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.

Sign up for GitHub

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

Merged
vstinner merged 6 commits into from
Aug 30, 2023
Merged

gh-108494: Argument Clinic: Document how to generate code that uses the limited C API #108584

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a8ba2b8
gh-108494: AC: Document How to use the Limited C API
vstinner Aug 28, 2023
96502df
Address reviews
vstinner Aug 29, 2023
8b2c572
Update Doc/howto/clinic.rst
vstinner Aug 29, 2023
60ec4ec
Update Doc/howto/clinic.rst
vstinner Aug 29, 2023
84687de
Update Doc/howto/clinic.rst
vstinner Aug 29, 2023
214f6bf
Update Misc/NEWS.d/next/Tools-Demos/2023-08-25-22-40-12.gh-issue-1084…
vstinner Aug 29, 2023
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
Prev Previous commit
Next Next commit
Update Doc/howto/clinic.rst 
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
  • Loading branch information
@vstinner @AlexWaygood
vstinner and AlexWaygood authored Aug 29, 2023
commit 60ec4ec77c6cfe8f3e28bcf4dfad42eb34ba2e5e
11 changes: 7 additions & 4 deletions Doc/howto/clinic.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1915,10 +1915,13 @@ blocks embedded in Python files look slightly different. They look like this:
How to use the Limited C API
Comment thread
vstinner marked this conversation as resolved.
----------------------------

If a C source code contains ``#define Py_LIMITED_API``, the generated C code
will use the :ref:`Limited API <limited-c-api>` to parse arguments. Private
functions are not used in this case. However, the code parsing arguments can be
less efficient depending on the parameters (types, number, etc.).
If Argument Clinic :term:`input` is located within a C source file
that contains ``#define Py_LIMITED_API``, Argument Clinic will generate C code
that uses the :ref:`Limited API <limited-c-api>` to parse arguments. The
advantage of this is that the generated code will not use private functions.
However, this *can* result in Argument Clinic generating less efficient code
in some cases. The extent of the performance penalty will depend
on the parameters (types, number, etc.).

.. versionadded:: 3.13

Expand Down