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

Uploaded Source

Built Distribution

abi3info-2023.3.20-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for abi3info-2023.3.20.tar.gz
Algorithm Hash digest
SHA256 ce098b127353a27ee0d8b453bb909b90a07baa4aa4916983231b6ebb3b800c7f
MD5 46870077efb75acac9a3a389d132708d
BLAKE2b-256 dbca034ffecfa28af21c0133ff2f54e78c1c3d4c6dcc6c26ca77a5867c7c5848

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for abi3info-2023.3.20-py3-none-any.whl
Algorithm Hash digest
SHA256 ada04c921955ecc6a7ef1fad633489198e870e299626648155528990de208c28
MD5 fa672794d4df370a6d5d8ba78efff8d2
BLAKE2b-256 f69ea49df3475567ee332904290a615d7cbe490cba8a3333af21cc98dcad7ba7

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