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.26.tar.gz (19.9 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: abi3info-2024.10.26.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.26.tar.gz
Algorithm Hash digest
SHA256 b41fdf4f19e1b39d1e7d8269ad12d59a18d54c71601818ca61b1ed5a87341d13
MD5 2606ef3105bd642571550c3a34d7c5cb
BLAKE2b-256 ea320d0f9b6b69385361d6cd45b16817910a3d2e13b5d9a5e06f5d550016ab77

See more details on using hashes here.

Provenance

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

Publisher: release.yml on woodruffw/abi3info

Attestations:

File details

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

File metadata

File hashes

Hashes for abi3info-2024.10.26-py3-none-any.whl
Algorithm Hash digest
SHA256 d5b132112ae94cebd1e2101083140794332bf1156cc7f4fd3869f42d85ca74e1
MD5 a9ef731841637fe77880a8230736077f
BLAKE2b-256 d3a189e3ecf2a985b8fed5ed5740b767f05f082c30df16e7b567dfa03f2d1fa4

See more details on using hashes here.

Provenance

The following attestation bundles were made for abi3info-2024.10.26-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