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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for abi3info-2023.6.20.tar.gz
Algorithm Hash digest
SHA256 e71502c086154a4a1840b20c8cad787ad9c597356977104b00e94d4ac4445273
MD5 8fecdf245fc5ef3d52cc2673c0d06fb1
BLAKE2b-256 dbc6a0b5db3c033fc9d88a82e862b3915e86a8ade070ee2c68ecd7c22b831c1d

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: abi3info-2023.6.20-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.4

File hashes

Hashes for abi3info-2023.6.20-py3-none-any.whl
Algorithm Hash digest
SHA256 e84a20b8019df50080e3d3fe9d575aa6c66ab35fb34741bd7968e57ace8e00d0
MD5 340ac381a876afb3223275967fe285e7
BLAKE2b-256 e7a443f5d2239abd333526ccfc3e6f41c1edb76a69018993b2469ae235ce74cb

See more details on using hashes here.

Provenance

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