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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for abi3info-2024.9.18.tar.gz
Algorithm Hash digest
SHA256 965e73c0acfb39b826dc063ae91cc5d932a2166eb22fd73359ee39f4211655a7
MD5 37ae5a5b0c65fc658f2a9495d6654e79
BLAKE2b-256 3f57b00d8787dc63dcc208730500fc3e435ba1c1808ccbad063b4d29f2701438

See more details on using hashes here.

File details

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

File metadata

  • Download URL: abi3info-2024.9.18-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.6

File hashes

Hashes for abi3info-2024.9.18-py3-none-any.whl
Algorithm Hash digest
SHA256 6d424754f0445ec606b1a478f2f235a3ea5443b0558dfb34658ab50a6686b3a8
MD5 1afbebba24ab7b42eeeadc84f8a3dcb1
BLAKE2b-256 72c5d3e5ac12100cd7e02923015d8c12b4aa1f9acf915aec98b9f892dbcaa86c

See more details on using hashes here.

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