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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: abi3info-2024.4.10.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.10.tar.gz
Algorithm Hash digest
SHA256 1548775e18952c6434cb050e9ade4a8eb266ab500101982efa376bd14518cc5e
MD5 4f70ad081dc04eef2b42fd639ef62854
BLAKE2b-256 82f8303cd7d59d739a8af265a5e6bc4ae7ad8afee80355c858f6ba5bdc6a62c6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: abi3info-2024.4.10-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.10-py3-none-any.whl
Algorithm Hash digest
SHA256 e1f4dec7c8650ebcedf871847c591e9ad028f266cadc1217bc579ff73074d5d1
MD5 57e1cece7a9f3a0229405c451cfc1a5e
BLAKE2b-256 6c7ba54c584c2dc40cdc173dfd80907fea13fea480e025b76b833fe1966552fe

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