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

Uploaded Source

Built Distribution

abi3info-2024.8.28-py3-none-any.whl (19.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: abi3info-2024.8.28.tar.gz
  • Upload date:
  • Size: 19.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for abi3info-2024.8.28.tar.gz
Algorithm Hash digest
SHA256 aecbaf340bb1b089c57d508b8eef583929466102a29754674a40efc3521321ca
MD5 6c9607ff883c828724e0168424cad1e4
BLAKE2b-256 ace0c453dfb74c8172090490f9cd6d9ae340fbf4d83a571216b64ec8bb31b6f1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: abi3info-2024.8.28-py3-none-any.whl
  • Upload date:
  • Size: 19.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for abi3info-2024.8.28-py3-none-any.whl
Algorithm Hash digest
SHA256 181e1199e92a8465bb8c09bcfedb07dd7986444be4122bb63f750e67e69fce6e
MD5 823f407bd75e14700211be827141505d
BLAKE2b-256 088d24b2841efb941c2749cba49b0e613c0603708c2d4db4f14fe61e1dd9b64f

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