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

Uploaded Source

Built Distribution

abi3info-2023.6.2-py3-none-any.whl (18.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: abi3info-2023.6.2.tar.gz
  • Upload date:
  • Size: 18.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for abi3info-2023.6.2.tar.gz
Algorithm Hash digest
SHA256 c773a8ea2f639f9fbde9b46212b0566626f39ccbd3d50898178f3e9d74e5df75
MD5 369fa8afb3b0a8d41667033625603143
BLAKE2b-256 1f4c75217eb4758f1fe02ce8f94c60c3dfce8fccb3c609aa33c4e2976d43faf8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: abi3info-2023.6.2-py3-none-any.whl
  • Upload date:
  • Size: 18.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for abi3info-2023.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0c3c2a8a852151fc52f1e494334e7a3b7087523d799b9471217975db77432638
MD5 7941b73b7badcc25f3cdc8bf9b48dbf5
BLAKE2b-256 7738a80bdf56c5057a424096cd858e5d5f622a9e816ec82ced935c5006d6e61d

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