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.2.3.post1.tar.gz (19.2 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file abi3info-2024.2.3.post1.tar.gz.

File metadata

  • Download URL: abi3info-2024.2.3.post1.tar.gz
  • Upload date:
  • Size: 19.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for abi3info-2024.2.3.post1.tar.gz
Algorithm Hash digest
SHA256 81bad5e4213c4981edb0365381c0022ec44e5a39620413ca13f226cf6e2eab3f
MD5 466e6b1c86baa60ac0dda0393836ac50
BLAKE2b-256 6992b5d80a755641cf31ba72cbe4bfafbd73bbf22b2957f4c7dc59c124a48b4d

See more details on using hashes here.

File details

Details for the file abi3info-2024.2.3.post1-py3-none-any.whl.

File metadata

File hashes

Hashes for abi3info-2024.2.3.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 872fd67cb0d0b4f3729c36e313a1a10a72aec8ccf6a66b83005e881e3804116a
MD5 ca5efc1b1ac07ff731a04b0ebf32cef5
BLAKE2b-256 7911a42c2f1208ce9bcb4ef66a144fa1067f80a7a5d89cfc6b130b740818e327

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