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

Uploaded Source

Built Distribution

abi3info-2024.6.25-py3-none-any.whl (19.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: abi3info-2024.6.25.tar.gz
  • Upload date:
  • Size: 19.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for abi3info-2024.6.25.tar.gz
Algorithm Hash digest
SHA256 e94bf88025c4bee77ebe0ff24a39b103dce646345de5e21f9fdfc8f9a00c1830
MD5 936eb7c11a44e80e23759624aba83ba2
BLAKE2b-256 3ba83223100090d37f36054159e761ab06694186ee32f6576b5dc4817d18921b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: abi3info-2024.6.25-py3-none-any.whl
  • Upload date:
  • Size: 19.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for abi3info-2024.6.25-py3-none-any.whl
Algorithm Hash digest
SHA256 7020d45f1af21a0004902b4f4b2d500caf181b278b1cd3f8400c3045e6ee57e9
MD5 4defd7e810e8c356fbb4d18c84bdc02b
BLAKE2b-256 dd2ca11af8c651c45d07eba03dbaa0adfc436df75d15d21524d1a0d4186a9e63

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