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

Uploaded Source

Built Distribution

abi3info-2023.8.25-py3-none-any.whl (18.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for abi3info-2023.8.25.tar.gz
Algorithm Hash digest
SHA256 090ae90fa8e0813807291211ea49f8cbab509a141af5025e18f6436fe9124030
MD5 b33bab2372a4a44f205e0ab6457f9ff1
BLAKE2b-256 17162bd65da8cae95b623a2b10204bfcc2e53b1ea8a7fc7463a3ae4bc9a87132

See more details on using hashes here.

File details

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

File metadata

  • Download URL: abi3info-2023.8.25-py3-none-any.whl
  • Upload date:
  • Size: 18.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for abi3info-2023.8.25-py3-none-any.whl
Algorithm Hash digest
SHA256 483889255afe42528ce267a802de0c0a7e5201cd8bb9da2798139e488e851914
MD5 fe6685799f1405727a95908b13c42c11
BLAKE2b-256 22246312cea278cc74bfc7e688c6adfa7cf357ecc86cfef275148c5345c84136

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