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

Uploaded Source

Built Distribution

abi3info-2023.10.18-py3-none-any.whl (18.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: abi3info-2023.10.18.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.18.tar.gz
Algorithm Hash digest
SHA256 2bdcade0e9e866caf498319473dc7d1144ba5270b376d644e801955249c3cd15
MD5 a536c36cb36ab38b0b39ed209c916811
BLAKE2b-256 ec7fe14b5997fc0946c94f91f4b3735a29eededee0ebce2b958d1d5c9439eb0d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for abi3info-2023.10.18-py3-none-any.whl
Algorithm Hash digest
SHA256 cafd2d7812dfeffb2cc4a0546bd25288f152a3e15cfa8d4c1ae6aa5f7a9ab504
MD5 ae2e10fd08e0e690508b415e986dfdc7
BLAKE2b-256 4eccc384b97aebf4ff25a1a87e96cbf3509a4dd47485b46148b8de27f510d712

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