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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: abi3info-2023.2.16.tar.gz
  • Upload date:
  • Size: 18.7 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.16.tar.gz
Algorithm Hash digest
SHA256 335d7f2407f01e886bac039b50847853d58ebb0dc511da4bd660e09ca6c6b025
MD5 a58a4e677b55bf0ca712e1a525840c48
BLAKE2b-256 dd0aea1e1b09fabee7e64090f957d2f0ce168aa184eae17a6b1fe12b12e95ae5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: abi3info-2023.2.16-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.2

File hashes

Hashes for abi3info-2023.2.16-py3-none-any.whl
Algorithm Hash digest
SHA256 e6b8dae2c1c23fa0630012286b3b96c701b24f04a416794f4013c1bf1aba17e3
MD5 87ee36941ee5c1e659ad7247fb913953
BLAKE2b-256 d5ce2b0702104d6b453bab9579d687e03022c4b301c1345c8f2bd9d941acdcfe

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