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

Uploaded Source

Built Distribution

abi3info-2024.3.26-py3-none-any.whl (18.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: abi3info-2024.3.26.tar.gz
  • Upload date:
  • Size: 19.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for abi3info-2024.3.26.tar.gz
Algorithm Hash digest
SHA256 6088d6d7920104309ab55877d2b2bfc8ace18c78cc89f9dedd9e92933308551d
MD5 eca8a952b601aec0c28214bcb1a95d82
BLAKE2b-256 058afdbc086c8fda87125f08adb36853e14f6231071d1306f90cbf5cd1a38abb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: abi3info-2024.3.26-py3-none-any.whl
  • Upload date:
  • Size: 18.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for abi3info-2024.3.26-py3-none-any.whl
Algorithm Hash digest
SHA256 3eea0188af83777c6b02abed3eeb5e73d82e2cf9d651c126a0624662a3725462
MD5 aeb2d85cc8dc1e6295494fccc362dbd9
BLAKE2b-256 5155cfd32df8068ef49fd7aa5fe9099d88ccc2d276bc87764b2c53471952cb54

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