pybind / pybind/pybind11

[BUG]: Compatibility issues between pybind11 and Py_LIMITED_API.

Open
#5,905 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

triage
Dominant language
C++
Stars
18k
Forks
2.3k
Avg merge
5d 17h
Merged PRs (30d)
10

Description

Required prerequisites
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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.