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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for abi3info-2024.2.15.tar.gz
Algorithm Hash digest
SHA256 198f9a565a7bf359c7709930d99d2a82bc4b718b427022ff8f5a4dfa0568391a
MD5 14bebdc33d25ba32797d12e919bd1107
BLAKE2b-256 4a48d7345f446e7cf5ab1572e6c8d3012a26e4025f809021685d81bf06337288

See more details on using hashes here.

File details

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

File metadata

  • Download URL: abi3info-2024.2.15-py3-none-any.whl
  • Upload date:
  • Size: 18.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for abi3info-2024.2.15-py3-none-any.whl
Algorithm Hash digest
SHA256 1862ba2b37acc64c882e5ddeae83dbb7483782312e61449bc4313a60dcd0dd70
MD5 be81e5e1e179aa32c45fe45748f354d1
BLAKE2b-256 bb0c2b4bba79b884176ca4a82157242734dd9d84d2aaf8fe81f7682b6e52ec94

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