[BUG]: Compatibility issues between pybind11 and Py_LIMITED_API.
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 18k
- Forks
- 2.3k
- Avg merge
- 5d 17h
- Merged PRs (30d)
- 10
Description
Required prerequisites
- Make sure you've read the documentation. Your issue may be addressed there.
- Search the issue tracker and Discussions to verify that this hasn't already been reported. +1 or comment there if it has.
- Consider asking first in the Gitter chat room or in a Discussion.
What version (or hash if on master) of pybind11 are you using?
3.0.1
Problem description
I wrote a demo using pybind11 and setuptools to install a function that prints "hello world" for use in Python. However, when I try to make the wheel package support multiple Python versions above 3.10, enabling Py_LIMITED_API results in an error. The error log is in the attachment, along with setup.py and my_extension.cpp.
However, if I compile using the pure Python C API, there are no issues (as shown in the commented section of my_extension.cpp). However, for the actual project I need to build the wheel package, the code is quite complex, and writing it with the pure Python C API is not very practical.
error.log
my_extension.cpp
setup.py
Reproducible example code
Is this a regression? Put the last known working version here if it is.
Not a regression
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the failure with the attached setup.py and my_extension.cpp, then read error.log to identify where Py_LIMITED_API conflicts with pybind11. Compare the failing limited-API build with the commented pure Python C API version. Done means the attached extension can build a wheel for Python versions above 3.10 with Py_LIMITED_API enabled.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, python
- Domain
- backend-api-design, build-system
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 28/100