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.8.9rc1.tar.gz (19.0 kB view details)

Uploaded Source

Built Distribution

abi3info-2023.8.9rc1-py3-none-any.whl (18.5 kB view details)

Uploaded Python 3

File details

Details for the file abi3info-2023.8.9rc1.tar.gz.

File metadata

  • Download URL: abi3info-2023.8.9rc1.tar.gz
  • Upload date:
  • Size: 19.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for abi3info-2023.8.9rc1.tar.gz
Algorithm Hash digest
SHA256 0ff704329c845247cc4be2c528f2573abd4547343dd398b5b25b84999c1a0c82
MD5 342fea1553f73a6958427cd1c89c5b24
BLAKE2b-256 9b0d64245326d808bb85ff85720974a60a1ac6c2e6ba409bf29f37d2241bdfcd

See more details on using hashes here.

File details

Details for the file abi3info-2023.8.9rc1-py3-none-any.whl.

File metadata

File hashes

Hashes for abi3info-2023.8.9rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 1afe862959ba10365d1c1945ab0cdbcb3eef242b0749bf6fc44bb1a655ecf78a
MD5 dfad08343c340abe5e83f7218a25d98a
BLAKE2b-256 c3a1d9ef5249e49b97557aa79ffe43ab8d80dbaa9585a83d861f6339a129bc1f

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