pypa / pypa/packaging.python.org
Expand documentation on building for the Limited API
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 1.7k
- Fork
- 1.7k
- Merge medio
- 3g 12h
- PR unite (30g)
- 4
Descrizione
PyPUG has a small section on extension module API compatibility, which links to Python's nice Limited API documentation. The Python docs imply that the Limited API can be used simply by setting Py_LIMITED_API and auditing API calls in the code, but there are some packaging concerns as well. As far as I can tell, enabling the Limited API requires setting three separate knobs:
Py_LIMITED_API, to hide non-stabilized symbols and potentially replace some macros with functions.- The setuptools
Extension(..., py_limited_api=True)flag, to use the correct filename for the extension module. - The wheel
py-limited-apioption, to correctly ABI tag the wheel. See also: https://github.com/pypa/setuptools/issues/4741
These knobs are distributed across the ecosystem and there doesn't seem to be any unified documentation for them. This blog post was helpful for general understanding, but doesn't provide fully actionable advice. A concrete guide would really help.
In addition, perhaps the docs could mention how to conditionally disable the Limited API when building for older Python releases. Packages may want to continue shipping version-specific wheels for releases that haven't stabilized all of the C functions they need. I used setup.py code like this:
_abi3 = sys.version_info >= (3, 11)
setup(
ext_modules=[
Extension(
'fizzbuzz', ['fizzbuzz.c'],
define_macros=[('Py_LIMITED_API', '0x030b0000')] if _abi3 else [],
py_limited_api=_abi3,
),
],
options={'bdist_wheel': {'py_limited_api': 'cp311'} if _abi3 else {}},
)
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia dalla sezione esistente sulla compatibilità ABI di PyPUG e dalla documentazione collegata di Python Limited API, quindi esamina le problematiche relative a setuptools e wheel descritte nell’issue. Il lavoro è completato quando è disponibile una guida concreta e unificata che copra le tre opzioni di configurazione e spieghi come disabilitare condizionalmente la Limited API per le versioni precedenti di Python.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- build-system, documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 38/100