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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: abi3info-2024.9.24.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.24.tar.gz
Algorithm Hash digest
SHA256 aa4b62c87f8461c72a12f7d9c5900e353d1f40a14cda9dab30686c68d2968cd9
MD5 94067518d14b013a5fb6439b99daf4d6
BLAKE2b-256 bdd1530627a1f5280ae3f53a18017835afa35d6bed29db1e5dd8273787e190a0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: abi3info-2024.9.24-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.24-py3-none-any.whl
Algorithm Hash digest
SHA256 35642a525f292d927264debeef4d4b7240d9d2ed36ae493d934240033101637e
MD5 4fb2e811ac962752a6577a186dfd18e2
BLAKE2b-256 c8bfcf402a3e1785fabd882e00e7fe98ae4879aaf74e7b8c96579c64db7e1232

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