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.12.6.post2.tar.gz (18.7 kB view details)

Uploaded Source

Built Distribution

abi3info-2022.12.6.post2-py3-none-any.whl (18.2 kB view details)

Uploaded Python 3

File details

Details for the file abi3info-2022.12.6.post2.tar.gz.

File metadata

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

File hashes

Hashes for abi3info-2022.12.6.post2.tar.gz
Algorithm Hash digest
SHA256 b1041404496abdaca4e6206673e676a5238dbb05f8c1b3735a71300d81414389
MD5 4684bf9d4c4cf3ab2bdd6fc199e383bb
BLAKE2b-256 93ee9fb7ac1525161d65d7c520b30eeee7d640984b326398dbdb884d97bc3bef

See more details on using hashes here.

Provenance

File details

Details for the file abi3info-2022.12.6.post2-py3-none-any.whl.

File metadata

File hashes

Hashes for abi3info-2022.12.6.post2-py3-none-any.whl
Algorithm Hash digest
SHA256 24707f571fcf4bc238f12ae3d8ab17506a26e19bfe3383f79ec06ed6b4490ba1
MD5 f401c8e3b41713dc5d4387fa10afeef6
BLAKE2b-256 5fbcf8f03678b6e7d97fae4eac10cde1bb75b272fb0f0df33bbb8a951a3b2abb

See more details on using hashes here.

Provenance

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