Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity
cpython/Doc/c-api/apiabiversion.rst

63 lines
2.3 KiB
ReStructuredText
Raw Normal View History

Doc: Replace the deprecated highlightlang directive by highlight. (#13377) highlightlang is deprecated since April 2018 in Sphinx. See https://github.com/sphinx-doc/sphinx/pull/4845
2019-05-17 06:55:34 -03:00
.. highlight:: c
Close #15465: Document C API version macros Mostly moving the existing macro docs over from the standard library docs to the C API docs where they belong. Patch by Kushal Das.
2013-03-07 09:14:44 -04:00
.. _apiabiversion:
***********************
API and ABI Versioning
***********************
bpo-43795: PEP 652 user documentation (GH-25668) - Reformat the C API and ABI Versioning page (and extend/clarify a bit) - Rewrite the stable ABI docs into a general text on C API Compatibility - Add a list of Limited API contents, and notes for the individual items. - Replace `Include/README.rst` with a link to a devguide page with the same info
2021-05-11 11:04:33 -03:00
CPython exposes its version number in the following macros.
Note that these correspond to the version code is **built** with,
not necessarily the version used at **run time**.
Close #15465: Document C API version macros Mostly moving the existing macro docs over from the standard library docs to the C API docs where they belong. Patch by Kushal Das.
2013-03-07 09:14:44 -04:00
bpo-43795: PEP 652 user documentation (GH-25668) - Reformat the C API and ABI Versioning page (and extend/clarify a bit) - Rewrite the stable ABI docs into a general text on C API Compatibility - Add a list of Limited API contents, and notes for the individual items. - Replace `Include/README.rst` with a link to a devguide page with the same info
2021-05-11 11:04:33 -03:00
See :ref:`stable` for a discussion of API and ABI stability across versions.
.. c:macro:: PY_MAJOR_VERSION
The ``3`` in ``3.4.1a2``.
.. c:macro:: PY_MINOR_VERSION
The ``4`` in ``3.4.1a2``.
.. c:macro:: PY_MICRO_VERSION
The ``1`` in ``3.4.1a2``.
.. c:macro:: PY_RELEASE_LEVEL
The ``a`` in ``3.4.1a2``.
This can be ``0xA`` for alpha, ``0xB`` for beta, ``0xC`` for release
candidate or ``0xF`` for final.
Close #15465: Document C API version macros Mostly moving the existing macro docs over from the standard library docs to the C API docs where they belong. Patch by Kushal Das.
2013-03-07 09:14:44 -04:00
bpo-43795: PEP 652 user documentation (GH-25668) - Reformat the C API and ABI Versioning page (and extend/clarify a bit) - Rewrite the stable ABI docs into a general text on C API Compatibility - Add a list of Limited API contents, and notes for the individual items. - Replace `Include/README.rst` with a link to a devguide page with the same info
2021-05-11 11:04:33 -03:00
.. c:macro:: PY_RELEASE_SERIAL
The ``2`` in ``3.4.1a2``. Zero for final releases.
.. c:macro:: PY_VERSION_HEX
The Python version number encoded in a single integer.
The underlying version information can be found by treating it as a 32 bit
number in the following manner:
+-------+-------------------------+-------------------------+--------------------------+
| Bytes | Bits (big endian order) | Meaning | Value for ``3.4.1a2`` |
+=======+=========================+=========================+==========================+
| 1 | 1-8 | ``PY_MAJOR_VERSION`` | ``0x03`` |
+-------+-------------------------+-------------------------+--------------------------+
| 2 | 9-16 | ``PY_MINOR_VERSION`` | ``0x04`` |
+-------+-------------------------+-------------------------+--------------------------+
| 3 | 17-24 | ``PY_MICRO_VERSION`` | ``0x01`` |
+-------+-------------------------+-------------------------+--------------------------+
| 4 | 25-28 | ``PY_RELEASE_LEVEL`` | ``0xA`` |
+ +-------------------------+-------------------------+--------------------------+
| | 29-32 | ``PY_RELEASE_SERIAL`` | ``0x2`` |
+-------+-------------------------+-------------------------+--------------------------+
Thus ``3.4.1a2`` is hexversion ``0x030401a2`` and ``3.10.0`` is
hexversion ``0x030a00f0``.
All the given macros are defined in :source:`Include/patchlevel.h`.