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

Uploaded Source

Built Distribution

abi3info-2023.2.19-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: abi3info-2023.2.19.tar.gz
  • Upload date:
  • Size: 18.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for abi3info-2023.2.19.tar.gz
Algorithm Hash digest
SHA256 cdee98584aa78b05211f40fd98b96c097bd8582f1d1859d540cefcafd7b917fe
MD5 c0b7177c718a8d9372780f68f6438583
BLAKE2b-256 79a09e70079ba3db64f91433fbf61d1cedc90965394e12825ef52107e4d68f9d

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: abi3info-2023.2.19-py3-none-any.whl
  • Upload date:
  • Size: 18.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for abi3info-2023.2.19-py3-none-any.whl
Algorithm Hash digest
SHA256 0cc32ade06780bdeaf2bd1558ccb1e18bcfe22559b25e190355a8528b10282da
MD5 47843aa9e350ab1ce52f556facf5ebae
BLAKE2b-256 3392cd6c2d90e278bdc946ac136aefb45bddf832b2f19a3e1fe82e701c737b8d

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