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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for abi3info-2023.2.8.tar.gz
Algorithm Hash digest
SHA256 09128470e24e3cb41d49453b791f7416164976864f8185f748199e25beb0ad87
MD5 5f063bcca6257ad38c1bff3dfbeeb54f
BLAKE2b-256 785a9d192459b107b581a7c6ccdf9cd52b90f236585641c9ef09736561c214b8

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for abi3info-2023.2.8-py3-none-any.whl
Algorithm Hash digest
SHA256 011437173efc6dc950fefb56e2e291f13b63e0ef7c8b6776a0560cf15578aebf
MD5 8b7beb4f9b100fb4ba72a8a4310933d9
BLAKE2b-256 dfa5f5446af09f954aeacaa66c54b377c315c0fe19df6ca3016fb507436d4e3e

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