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

Uploaded Source

Built Distribution

abi3info-2023.10.22-py3-none-any.whl (18.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: abi3info-2023.10.22.tar.gz
  • Upload date:
  • Size: 19.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for abi3info-2023.10.22.tar.gz
Algorithm Hash digest
SHA256 b02a11119d417e02e2e2ebb0adf247f6796fa19906d2c49926d207b22f19e3ef
MD5 3ce35dc5d89e076502875fb3e53a1bf1
BLAKE2b-256 4fd9366f6670b677f68c96cb06a5ab58c410be888bcb19bd39743e7e177db9d0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for abi3info-2023.10.22-py3-none-any.whl
Algorithm Hash digest
SHA256 903dc0cab3de86750555601fa6c7af6181bc9c246d2f20f0f834b3e6732e1ba0
MD5 695f2e38ea941b4a89e2dee871e61543
BLAKE2b-256 322312b6183f5042c0cb8ab50f4a3c4634240d8c1b1fe139d673b1ce069ea197

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