API and ABI Versioning¶
Build-time version constants¶
CPython exposes its version number in the following macros.Note that these correspond to the version code isbuilt with.SeePy_Version for the version used atrun time.
SeeC API Stability for a discussion of API and ABI stability across versions.
- PY_MAJOR_VERSION¶
The
3in3.4.1a2.
- PY_MINOR_VERSION¶
The
4in3.4.1a2.
- PY_MICRO_VERSION¶
The
1in3.4.1a2.
- PY_RELEASE_LEVEL¶
The
ain3.4.1a2.This can be0xAfor alpha,0xBfor beta,0xCfor releasecandidate or0xFfor final.
- PY_RELEASE_SERIAL¶
The
2in3.4.1a2. Zero for final releases.
- PY_VERSION_HEX¶
The Python version number encoded in a single integer.See
Py_PACK_FULL_VERSION()for the encoding details.Use this for numeric comparisons, for example,
#ifPY_VERSION_HEX>=....
Run-time version¶
- constunsignedlongPy_Version¶
- Part of theStable ABI since version 3.11.
The Python runtime version number encoded in a single constant integer.See
Py_PACK_FULL_VERSION()for the encoding details.This contains the Python version used at run time.Use this for numeric comparisons, for example,
if(Py_Version>=...).Added in version 3.11.
Bit-packing macros¶
- uint32_tPy_PACK_FULL_VERSION(intmajor,intminor,intmicro,intrelease_level,intrelease_serial)¶
- Part of theStable ABI since version 3.14.
Return the given version, encoded as a single 32-bit integer withthe following structure:
Argument
No.ofbits
Bit mask
Bit shift
Example values
3.4.1a23.10.0major
8
0xFF00000024
0x030x03minor
8
0x00FF000016
0x040x0Amicro
8
0x0000FF008
0x010x00release_level
4
0x000000F04
0xA0xFrelease_serial
4
0x0000000F0
0x20x0For example:
Version
Py_PACK_FULL_VERSIONargumentsEncoded version
3.4.1a2(3,4,1,0xA,2)0x030401a23.10.0(3,10,0,0xF,0)0x030a00f0Out-of range bits in the arguments are ignored.That is, the macro can be defined as:
#ifndef Py_PACK_FULL_VERSION#define Py_PACK_FULL_VERSION(X, Y, Z, LEVEL, SERIAL) ( \ (((X) & 0xff) << 24) | \ (((Y) & 0xff) << 16) | \ (((Z) & 0xff) << 8) | \ (((LEVEL) & 0xf) << 4) | \ (((SERIAL) & 0xf) << 0))#endif
Py_PACK_FULL_VERSIONis primarily a macro, intended for use in#ifdirectives, but it is also available as an exported function.Added in version 3.14.
- uint32_tPy_PACK_VERSION(intmajor,intminor)¶
- Part of theStable ABI since version 3.14.
Equivalent to
Py_PACK_FULL_VERSION(major,minor,0,0,0).The result does not correspond to any Python release, but is usefulin numeric comparisons.Added in version 3.14.