Stabilité de l’API C

L'API C respecte la politique de rétrocompatibilité de Python, PEP 387. Malgré la présence d’évolutions dans chaque version mineure (par exemple entre 3.9 et 3.10), la majorité de ces changements n'affecte pas la compatibilité du code source. Typiquement des API sont ajoutées mais pas modifiées ou supprimées, bien que cela puisse arriver après une période de dépréciation ou pour corriger un problème important.

L’interface binaire de CPython (ABI) est entièrement compatible au sein d’une version mineure (à condition que la compilation soit toujours faite de même manière, comme indiqué dans Considérations relatives aux plateformes ci-dessous). Ainsi le code compilé pour Python 3.10.0 fonctionnera avec Python 3.10.8 et inversement, mais il devra être compilé séparément pour 3.9.x et 3.10.x.

Les noms commençant par un caractère souligné, comme _Py_InternalState, font partie de l’API privée et peuvent changer sans préavis même dans une version de correctif.

ABI Stable

Le concept d’API restreinte, un sous-ensemble de l’API C de Python, existe depuis Python 3.2. Les extensions qui utilisent uniquement l’API restreinte peuvent être compilées une seule fois et fonctionner avec plusieurs versions de Python. Les objets faisant partie de l’API restreinte sont documentés ci-dessous.

Python a aussi une ABI stable : un ensemble de symboles qui sont compatibles avec l’ensemble des versions Python 3.x. L’ABI stable contient les symboles utilisés par l’API restreinte, mais pas seulement — par exemple les fonctions nécessaires pour supporter les versions précédentes de l’API restreinte en font aussi partie.

(Par simplicité ce document parle d’extensions, mais l’API restreinte et l’ABI stable fonctionnent de la même manière pour tous les cas d’usages de l’API — par exemple pour embarquer Python.)

Py_LIMITED_API

Définissez cette macro avant d’inclure Python.h pour n’inclure que l’API restreinte et indiquer sa version.

Définissez Py_LIMITED_API à la valeur de PY_VERSION_HEX correspond à la version minimale de Python que votre extension supporte. Cette extension fonctionnera sans re-compilation avec toutes les versions futures de Python 3, et peut utiliser l’ensemble des éléments de l’API restreinte présent dans cette version.

Il est recommandé de renseigner une version mineure minimale (par exemple 0x030A0000 pour Python 3.10) plutôt que d’utiliser directement la macro PY_VERSION_HEX pour ne pas dépendre de la version de Python utilisée lors de la compilation.

Vous pouvez aussi définir Py_LIMITED_API à 3. Cette valeur est équivalente à 0x03020000 correspondant à Python 3.2, la première version à supporter l’API restreinte.

Sur Windows les extensions qui utilisent l’ABI stable doivent être liées avec python3.dll et non pas avec une bibliothèque spécifique à une version comme python39.dll.

Sur certaines plateformes Python essaiera de charger une bibliothèque partagée dont le nom contient abi3 (par exemple mymodule.abi3.so). Il ne vérifie pas si ces extensions respectent l’ABI stable. L’utilisateur (ou ses outils d’administration) doit s’assurer que les extensions compilées avec une version donnée de l’API restreinte, par exemple 3.10+, ne sont pas utilisées avec des versions plus anciennes de Python.

Toutes les fonctions de l’ABI stable sont présentes dans la bibliothèque dynamique de Python en tant que fonction, et pas uniquement comme macro. Elles peuvent donc être utilisées avec des langages qui n’utilisent pas le pré-processeur C.

Porté de l’API restreinte et performance

L’objectif de l’API restreinte est de permettre l’ensemble des opérations possibles avec l’API C étendue, mais peut avoir un impact sur les performances.

Par exemple la fonction PyList_GetItem() est disponible, mais la macro « dangereuse » PyList_GET_ITEM() ne l’est pas. Cette macro peut être plus rapide car elle dépend de détails d’implémentation spécifique à l’objet list.

Si Py_LIMITED_API n’est pas défini certaines fonctions de l’API C seront remplacées par des macros ou une version en-ligne. Définir Py_LIMITED_API désactive cette optimisation, permettant de se garantir contre les évolutions des structures de données utilisées par Python, et peut réduire les performances.

En omettant la définition de Py_LIMITED_API il est possible de compiler une extension utilisant l’API restreinte avec une version spécifique de l’ABI. Les performances seront meilleures pour cette version de Python, mais la compatibilité sera réduite. Compiler en définissant Py_LIMITED_API produira une extension qui peut être utilisée quand une variante spécifique à une version n’est pas disponible — par exemple pour une version alpha de Python.

Inconvénients de l’API restreinte

Compiler avec Py_LIMITED_API n’est pas une garantie absolue que le code est conforme à l’API restreinte ou à l’ABI stable. Py_LIMITED_API ne concerne que la définition des objets, mais une API inclut aussi d’autres spécificités comme le comportement attendu.

Une des limitations est que Py_LIMITED_API ne protège pas contre l’appel d’une fonction avec des arguments qui sont invalides pour une version de Python plus ancienne. Par exemple considérons une fonction qui accepte NULL comme argument à partir de 3.9. NULL permet maintenant d’utiliser le comportement par défaut, mais Python 3.8 essayera d’accéder à l’objet pointé et dé-référencera NULL, causant un crash. Des problèmes similaires peuvent se produire avec les attributs des structures.

Un autre problème est que certains attributs ne sont pas encore cachés lorsque Py_LIMITED_API est défini, même s’ils ne font pas partie de l’API restreinte.

Pour ces raisons il est recommandé de tester une extension avec l’ensemble des versions mineures supportées de Python, et généralement de la compiler avec la plus ancienne de ces versions.

Il est aussi recommandé de vérifier la documentation de toutes les API utilisées pour vérifier qu’elles fassent bien partie de l’API restreinte. Même lorsque Py_LIMITED_API est défini quelques fonctions privées peuvent être exposées aux utilisateurs pour des raisons techniques, ou par erreur.

Notez aussi que l’API restreinte n’est pas forcément stable : compiler avec Python 3.8 en définissant Py_LIMITED_API garanti que l’extension fonctionnera avec Python 3.12, mais pas qu’elle pourra être compilée avec Python 3.12. En particulier certaines parties de l’API restreinte peuvent être dépréciées et retirées tant que l’ABI stable n’est pas modifiée.

Considérations relatives aux plateformes

La stabilité de l’ABI ne dépend pas que de Python mais aussi du compilateur utilisé, des bibliothèques systèmes et des options du compilateur. L’ensemble de ces détails correspondent à ce que l’ABI stable appelle une « plateforme ». Ils dépendent généralement du système d’exploitation et de l’architecture du processeur.

Les distributeurs de Python doivent s’assurer que toutes les versions de Python pour une plateforme donnée sont compilées de manière à ne pas rompre la compatibilité de l’ABI stable. C’est le cas des versions produites pour Windows et macOS de python.org et de la plupart des distributions tierces.

Contenu de l’API restreinte

Pour le moment l’API restreinte inclut les éléments suivants :