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

Uploaded Source

Built Distribution

abi3info-2024.4.25-py3-none-any.whl (19.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for abi3info-2024.4.25.tar.gz
Algorithm Hash digest
SHA256 fce8da37363c82a2681ed91f5c60f00daf95beed9e4bb868b15350dcfe760aa9
MD5 20450c1605a85aa0d1be43698a5c684e
BLAKE2b-256 011a262b6492a13441de9430361d637c9088f3064d35989833ef2f73789d0749

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for abi3info-2024.4.25-py3-none-any.whl
Algorithm Hash digest
SHA256 099de718bf47e8e6effa6d6ebbe5ad713461dcef203583403277deec5089d885
MD5 966a087f4bb597317e7d657c17045df3
BLAKE2b-256 2d9acdc36a445dd49930113aec378e1f8881a51a9fc8a6bd5611ffd845d7618d

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