Skip to main content

A library for abi3 and other CPython API information

Project description

abi3info

CI

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

Uploaded Source

Built Distribution

abi3info-2022.11.30-py3-none-any.whl (18.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: abi3info-2022.11.30.tar.gz
  • Upload date:
  • Size: 18.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for abi3info-2022.11.30.tar.gz
Algorithm Hash digest
SHA256 4bb37732370a141b1f071c843e90ddb179b58b436f08ff53252704493dbb26c2
MD5 4f35f4a400065509098a4f4fa367f3e9
BLAKE2b-256 11766da11bfab160c7cb1254c3a6cb954a0f02f176c715c90cbffef5642c9861

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for abi3info-2022.11.30-py3-none-any.whl
Algorithm Hash digest
SHA256 0cc2fd22bbec3012687f00e23092a9475cf1a976ba67dcfe90ba14db604f167e
MD5 9326dba1601cb211962eaa055af85077
BLAKE2b-256 5dbd039317104a4095146b86c2dbbaa16addfb01df7d6919fdb958c4c1717087

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