Skip to main content

A library for abi3 and other CPython API information

Project description

abi3info

CI PyPI version

abi3info exposes information about CPython's "limited API" (including the stable ABI, called abi3) as a Python library.

Installation

abi3info is available via pip:

$ pip install abi3info

Usage

abi3info exposes limited API and stable ABI information in the form of a set of top-level dictionaries, namely:

import abi3info

abi3info.FEATURE_MACROS
abi3info.MACROS
abi3info.STRUCTS
abi3info.TYPEDEFS
abi3info.FUNCTIONS
abi3info.DATAS

Each of these is a mapping of a name (either as str or Symbol) to a data model describing the kind of item (e.g. FeatureMacro or Function).

See the generated documentation for more details, including comprehensive type hints and explanations of each data model.

See also the stable_abi.toml file, taken from the CPython sources, which describes each model and their semantics.

Examples

Get information about a particular function:

from abi3info import FUNCTIONS
from abi3info.models import Symbol

func = FUNCTIONS[Symbol("_Py_NegativeRefcount")]
print(func.symbol, func.added, func.ifdef, func.abi_only)

Get information about the feature macros that control the limited API:

from abi3info import FEATURE_MACROS

print(fm for fm in FEATURE_MACROS.values())

Licensing

abi3info is licensed under the MIT license.

abi3info is partially generated from metadata retrieved from the CPython sources, which is licensed under the PSF license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

abi3info-2024.10.3.tar.gz (19.9 kB view details)

Uploaded Source

Built Distribution

abi3info-2024.10.3-py3-none-any.whl (19.3 kB view details)

Uploaded Python 3

File details

Details for the file abi3info-2024.10.3.tar.gz.

File metadata

  • Download URL: abi3info-2024.10.3.tar.gz
  • Upload date:
  • Size: 19.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for abi3info-2024.10.3.tar.gz
Algorithm Hash digest
SHA256 5a69b1d31563c10043e17b124a1dc8353ab682e44f4e837aacced8907b987c3b
MD5 acc9b1b2aa715f623d7e2c7c161f604e
BLAKE2b-256 0941b9ab185bae1ba7ef69397aa1b1efea5682510b1657cd01a24b6c319d8993

See more details on using hashes here.

Provenance

The following attestation bundles were made for abi3info-2024.10.3.tar.gz:

Publisher: release.yml on woodruffw/abi3info

Attestations:

File details

Details for the file abi3info-2024.10.3-py3-none-any.whl.

File metadata

  • Download URL: abi3info-2024.10.3-py3-none-any.whl
  • Upload date:
  • Size: 19.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for abi3info-2024.10.3-py3-none-any.whl
Algorithm Hash digest
SHA256 01577e2314093011854ec7e888dc3fd25e19031bc121a8c394430da06e1fd4dc
MD5 4da6472e04e26368729fc915183a0a1b
BLAKE2b-256 aa837deb11e4067e0e2b264721eee7026fd4f30d94e7c2e0d80ab046401e45d3

See more details on using hashes here.

Provenance

The following attestation bundles were made for abi3info-2024.10.3-py3-none-any.whl:

Publisher: release.yml on woodruffw/abi3info

Attestations:

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page