python / python/cpython

Machine-readable specification for deprecated and removed CPython APIs

Open
#134,222 2 comments 0 reactions 2 assignees View on GitHub

@CAM-Gerlach is already working on this.

Since May 19, 2025.

docs type-feature
Dominant language
Python
Stars
77.2k
Forks
35.9k
PR merge metrics
PR metrics pending

Description

See the details from https://discuss.python.org/t/machine-readable-specification-for-deprecated-and-removed-apis-of-cpython/92039

What we need

Working prototype:

  • Read in TOML
  • Process data as needed (basic fields)
  • Add directive to output deprecation in docs
  • Output JSON

Initial implementation

  • Formalize JSON output
  • Validation for input schema (JSONschema?)
  • Process remaining data processing
  • Generate admonition messages from the individual keys

cc @CAM-Gerlach

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.