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

Uploaded Source

Built Distribution

abi3info-2022.11.30.post1-py3-none-any.whl (18.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: abi3info-2022.11.30.post1.tar.gz
  • Upload date:
  • Size: 18.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for abi3info-2022.11.30.post1.tar.gz
Algorithm Hash digest
SHA256 bb9ef481a79e044c1a9967e613febae210f3036161eba39ade8c1ef889e9e219
MD5 689319dcd5828d25a4f4907ce068a127
BLAKE2b-256 e25f4c5528fc87cc0fc79b0ca6d0ab2e4d1902fe4070b4e0837a729bd8c394be

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for abi3info-2022.11.30.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 490fc305a1e5ec3a56da4e5862274111e96fce7d487eec54e8c72ffcbd16be98
MD5 6e9f89d4330df58c36c76780eb21cf44
BLAKE2b-256 3ffe17fa797be6a3eb6ef9bdec84ec7af7508b54cfb8ba288a38ac10f47fd28e

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