Skip to content
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

Jump to bottom

clarify limited API support a bit #106

Merged
merged 3 commits into from
Nov 4, 2024
Merged

clarify limited API support a bit #106

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d304279
clarify limited API support a bit
ngoldbaum Nov 4, 2024
7fd8b71
[pre-commit.ci lite] apply automatic fixes
pre-commit-ci-lite[bot] Nov 4, 2024
4768ddf
respond to ralf's suggestions
ngoldbaum Nov 4, 2024
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
13 changes: 8 additions & 5 deletions docs/porting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -712,8 +712,11 @@ build.
### Limited API support

The free-threaded build does not support the limited CPython C API. If you
currently use the limited API you will not be able to use it while shipping
binaries for the free-threaded build. This also means that code inside
`#ifdef Py_GIL_DISABLED` checks can use C API constructs outside the limited API if you
would like to do that, although these uses will need to be removed once the
free-threaded build gains support for compiling with the limited API.
currently use the limited API to build wheels that do not depend on a specific
Python version, you will not be able to use it while shipping binaries for the
free-threaded build. In practice, the limited API is a subset of the full C API,
so your extension will build, you just cannot set `Py_LIMITED_API` at build
time. This also means that code inside `#ifdef Py_GIL_DISABLED` checks can use C
API constructs outside the limited API if you would like to do that, although
these uses will need to be removed once the free-threaded build gains support
for compiling with the limited API.