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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file abi3info-2023.3.20a1.tar.gz.

File metadata

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

File hashes

Hashes for abi3info-2023.3.20a1.tar.gz
Algorithm Hash digest
SHA256 dec640eff44aa8ee9c6c7e6d6416ede429e47e349f1f74dc351a94e54ea4a8ec
MD5 1e3830b00da6d429d9cdc126a45a67c5
BLAKE2b-256 cb2f76a56c4923356442b7cfc4bb4c3ca92f6c567dfed3db75d6ca2d1f46e570

See more details on using hashes here.

File details

Details for the file abi3info-2023.3.20a1-py3-none-any.whl.

File metadata

File hashes

Hashes for abi3info-2023.3.20a1-py3-none-any.whl
Algorithm Hash digest
SHA256 0a171c942f8b6cd04b6dc46a2648df22a4fd90fb6b2a63090e36e4a249338b36
MD5 a86782f19892f3e83e51dbf449b818d5
BLAKE2b-256 ad99362a51230d12584fe693fd06897d59da6e18270374c0315e8c099f112f47

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