CINXE.COM

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="color-scheme" content="light dark"> <title>PEP 739 – Static description file for build details of Python installations | peps.python.org</title> <link rel="shortcut icon" href="../_static/py.png"> <link rel="canonical" href="https://peps.python.org/pep-0739/"> <link rel="stylesheet" href="../_static/style.css" type="text/css"> <link rel="stylesheet" href="../_static/mq.css" type="text/css"> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" media="(prefers-color-scheme: light)" id="pyg-light"> <link rel="stylesheet" href="../_static/pygments_dark.css" type="text/css" media="(prefers-color-scheme: dark)" id="pyg-dark"> <link rel="alternate" type="application/rss+xml" title="Latest PEPs" href="https://peps.python.org/peps.rss"> <meta property="og:title" content='PEP 739 – Static description file for build details of Python installations | peps.python.org'> <meta property="og:description" content="Introduce a standard format for a static description file with build details of Python installations."> <meta property="og:type" content="website"> <meta property="og:url" content="https://peps.python.org/pep-0739/"> <meta property="og:site_name" content="Python Enhancement Proposals (PEPs)"> <meta property="og:image" content="https://peps.python.org/_static/og-image.png"> <meta property="og:image:alt" content="Python PEPs"> <meta property="og:image:width" content="200"> <meta property="og:image:height" content="200"> <meta name="description" content="Introduce a standard format for a static description file with build details of Python installations."> <meta name="theme-color" content="#3776ab"> </head> <body> <svg xmlns="http://www.w3.org/2000/svg" style="display: none;"> <symbol id="svg-sun-half" viewBox="0 0 24 24" pointer-events="all"> <title>Following system colour scheme</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"> <circle cx="12" cy="12" r="9"></circle> <path d="M12 3v18m0-12l4.65-4.65M12 14.3l7.37-7.37M12 19.6l8.85-8.85"></path> </svg> </symbol> <symbol id="svg-moon" viewBox="0 0 24 24" pointer-events="all"> <title>Selected dark colour scheme</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"> <path stroke="none" d="M0 0h24v24H0z" fill="none"></path> <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z"></path> </svg> </symbol> <symbol id="svg-sun" viewBox="0 0 24 24" pointer-events="all"> <title>Selected light colour scheme</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"> <circle cx="12" cy="12" r="5"></circle> <line x1="12" y1="1" x2="12" y2="3"></line> <line x1="12" y1="21" x2="12" y2="23"></line> <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line> <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line> <line x1="1" y1="12" x2="3" y2="12"></line> <line x1="21" y1="12" x2="23" y2="12"></line> <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line> <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line> </svg> </symbol> </svg> <script> document.documentElement.dataset.colour_scheme = localStorage.getItem("colour_scheme") || "auto" </script> <section id="pep-page-section"> <header> <h1>Python Enhancement Proposals</h1> <ul class="breadcrumbs"> <li><a href="https://www.python.org/" title="The Python Programming Language">Python</a> » </li> <li><a href="../pep-0000/">PEP Index</a> » </li> <li>PEP 739</li> </ul> <button id="colour-scheme-cycler" onClick="setColourScheme(nextColourScheme())"> <svg aria-hidden="true" class="colour-scheme-icon-when-auto"><use href="#svg-sun-half"></use></svg> <svg aria-hidden="true" class="colour-scheme-icon-when-dark"><use href="#svg-moon"></use></svg> <svg aria-hidden="true" class="colour-scheme-icon-when-light"><use href="#svg-sun"></use></svg> Toggle light / dark / auto colour theme </button> </header> <article> <section id="pep-content"> <h1 class="page-title">PEP 739 – Static description file for build details of Python installations</h1> <dl class="rfc2822 field-list simple"> <dt class="field-odd">Author:</dt> <dd class="field-odd">Filipe Laíns <lains at riseup.net></dd> <dt class="field-even">PEP-Delegate:</dt> <dd class="field-even">Paul Moore <p.f.moore at gmail.com></dd> <dt class="field-odd">Discussions-To:</dt> <dd class="field-odd"><a class="reference external" href="https://discuss.python.org/t/pep-739-static-description-file-for-build-details-of-python-installations/44572">Discourse thread</a></dd> <dt class="field-even">Status:</dt> <dd class="field-even"><abbr title="Proposal under active discussion and revision">Draft</abbr></dd> <dt class="field-odd">Type:</dt> <dd class="field-odd"><abbr title="Normative PEP with a new feature for Python, implementation change for CPython or interoperability standard for the ecosystem">Standards Track</abbr></dd> <dt class="field-even">Topic:</dt> <dd class="field-even"><a class="reference external" href="../topic/packaging/">Packaging</a></dd> <dt class="field-odd">Created:</dt> <dd class="field-odd">19-Dec-2023</dd> <dt class="field-even">Python-Version:</dt> <dd class="field-even">3.14</dd> </dl> <hr class="docutils" /> <section id="contents"> <details><summary>Table of Contents</summary><ul class="simple"> <li><a class="reference internal" href="#abstract">Abstract</a></li> <li><a class="reference internal" href="#rationale">Rationale</a></li> <li><a class="reference internal" href="#scope">Scope</a></li> <li><a class="reference internal" href="#location">Location</a></li> <li><a class="reference internal" href="#format">Format</a><ul> <li><a class="reference internal" href="#schema-version"><code class="docutils literal notranslate">schema_version</code></a></li> <li><a class="reference internal" href="#base-prefix"><code class="docutils literal notranslate">base_prefix</code></a></li> <li><a class="reference internal" href="#platform"><code class="docutils literal notranslate">platform</code></a></li> <li><a class="reference internal" href="#language"><code class="docutils literal notranslate">language</code></a><ul> <li><a class="reference internal" href="#language-version"><code class="docutils literal notranslate">language.version</code></a></li> <li><a class="reference internal" href="#language-version-info"><code class="docutils literal notranslate">language.version_info</code></a><ul> <li><a class="reference internal" href="#language-version-info-major"><code class="docutils literal notranslate">language.version_info.major</code></a></li> <li><a class="reference internal" href="#language-version-info-minor"><code class="docutils literal notranslate">language.version_info.minor</code></a></li> <li><a class="reference internal" href="#language-version-info-micro"><code class="docutils literal notranslate">language.version_info.micro</code></a></li> <li><a class="reference internal" href="#language-version-info-releaselevel"><code class="docutils literal notranslate">language.version_info.releaselevel</code></a></li> <li><a class="reference internal" href="#language-version-info-serial"><code class="docutils literal notranslate">language.version_info.serial</code></a></li> </ul> </li> </ul> </li> <li><a class="reference internal" href="#implementation"><code class="docutils literal notranslate">implementation</code></a><ul> <li><a class="reference internal" href="#implementation-name"><code class="docutils literal notranslate">implementation.name</code></a></li> <li><a class="reference internal" href="#implementation-version"><code class="docutils literal notranslate">implementation.version</code></a><ul> <li><a class="reference internal" href="#implementation-version-major"><code class="docutils literal notranslate">implementation.version.major</code></a></li> <li><a class="reference internal" href="#implementation-version-minor"><code class="docutils literal notranslate">implementation.version.minor</code></a></li> <li><a class="reference internal" href="#implementation-version-micro"><code class="docutils literal notranslate">implementation.version.micro</code></a></li> <li><a class="reference internal" href="#implementation-version-releaselevel"><code class="docutils literal notranslate">implementation.version.releaselevel</code></a></li> <li><a class="reference internal" href="#implementation-version-serial"><code class="docutils literal notranslate">implementation.version.serial</code></a></li> </ul> </li> </ul> </li> <li><a class="reference internal" href="#interpreter"><code class="docutils literal notranslate">interpreter</code></a><ul> <li><a class="reference internal" href="#interpreter-path"><code class="docutils literal notranslate">interpreter.path</code></a></li> </ul> </li> <li><a class="reference internal" href="#abi"><code class="docutils literal notranslate">abi</code></a><ul> <li><a class="reference internal" href="#abi-flags"><code class="docutils literal notranslate">abi.flags</code></a></li> <li><a class="reference internal" href="#abi-extension-suffix"><code class="docutils literal notranslate">abi.extension_suffix</code></a></li> <li><a class="reference internal" href="#abi-stable-abi-suffix"><code class="docutils literal notranslate">abi.stable_abi_suffix</code></a></li> </ul> </li> <li><a class="reference internal" href="#suffixes"><code class="docutils literal notranslate">suffixes</code></a></li> <li><a class="reference internal" href="#libpython"><code class="docutils literal notranslate">libpython</code></a><ul> <li><a class="reference internal" href="#libpython-dynamic"><code class="docutils literal notranslate">libpython.dynamic</code></a></li> <li><a class="reference internal" href="#libpython-dynamic-stableabi"><code class="docutils literal notranslate">libpython.dynamic_stableabi</code></a></li> <li><a class="reference internal" href="#libpython-static"><code class="docutils literal notranslate">libpython.static</code></a></li> <li><a class="reference internal" href="#libpython-link-to-libpython"><code class="docutils literal notranslate">libpython.link_to_libpython</code></a></li> </ul> </li> <li><a class="reference internal" href="#c-api"><code class="docutils literal notranslate">c_api</code></a><ul> <li><a class="reference internal" href="#c-api-headers"><code class="docutils literal notranslate">c_api.headers</code></a></li> <li><a class="reference internal" href="#c-api-pkgconfig-path"><code class="docutils literal notranslate">c_api.pkgconfig_path</code></a></li> </ul> </li> <li><a class="reference internal" href="#arbitrary-data"><code class="docutils literal notranslate">arbitrary_data</code></a></li> </ul> </li> <li><a class="reference internal" href="#example">Example</a></li> <li><a class="reference internal" href="#json-schema">JSON Schema</a></li> <li><a class="reference internal" href="#rejected-ideas">Rejected Ideas</a><ul> <li><a class="reference internal" href="#having-a-larger-scope">Having a larger scope</a></li> </ul> </li> <li><a class="reference internal" href="#copyright">Copyright</a></li> </ul> </details></section> <section id="abstract"> <h2><a class="toc-backref" href="#abstract" role="doc-backlink">Abstract</a></h2> Introduce a standard format for a static description file with build details of Python installations. </section> <section id="rationale"> <h2><a class="toc-backref" href="#rationale" role="doc-backlink">Rationale</a></h2> When introspecting a Python installation, running code is often undesirable or impossible. Having a static description file makes various of Python build details available without having to run the interpreter. This is helpful for use-cases such as cross-compilation, Python launchers, etc. </section> <section id="scope"> <h2><a class="toc-backref" href="#scope" role="doc-backlink">Scope</a></h2> This PEP defines a format for the description file, and a standard location for where to place it. </section> <section id="location"> <h2><a class="toc-backref" href="#location" role="doc-backlink">Location</a></h2> When possible, Python installations should install the static description file inside the standard library directory, with the name <code class="docutils literal notranslate">build-details.json</code> (Eg. <code class="docutils literal notranslate">/usr/lib/python3.14/build-details.json</code>). <div class="admonition important"> Important Given that there may be technical challenges, Python implementations are not required to provide the file if not feasable. In such scenarios, they may choose to provide it in a different maner. </div> <div class="admonition attention"> Attention Notwithstanding the standard location specified here, it does not prevent the file from additionally being provided in another location, and with a different name. In fact, the PEP authors expect future PEPs to define additional locations to install this file, for better discoverability. </div> </section> <section id="format"> <h2><a class="toc-backref" href="#format" role="doc-backlink">Format</a></h2> The format specification is defined by the JSON Schema definition provided below, which is rendered in an human-readable format here. <table class="docutils align-default" id="spec-start"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td><code class="docutils literal notranslate">$schema</code></td> <td><a class="reference external" href="https://json-schema.org/draft/2020-12/schema">https://json-schema.org/draft/2020-12/schema</a></td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate">$id</code></td> <td><a class="reference external" href="https://github.com/python/peps/blob/main/peps/pep-0739/python-build-info-v1.0.schema.json">https://github.com/python/peps/blob/main/peps/pep-0739/python-build-info-v1.0.schema.json</a></td> </tr> <tr class="row-odd"><td>Title</td> <td>Static description file for the build details of Python installations</td> </tr> <tr class="row-even"><td>Type</td> <td><code class="docutils literal notranslate">object</code></td> </tr> <tr class="row-odd"><td>Additional properties</td> <td>Not allowed</td> </tr> </tbody> </table> <section id="schema-version"> <h3><a class="toc-backref" href="#schema-version" role="doc-backlink"><code class="docutils literal notranslate">schema_version</code></a></h3> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">string</code> (constant — <code class="docutils literal notranslate">1.0</code>)</td> </tr> <tr class="row-even"><td>Description</td> <td>Schema version.This is a string following the format <code class="docutils literal notranslate"><MAJOR>.<MINOR></code>, where <code class="docutils literal notranslate"><MAJOR></code> and <code class="docutils literal notranslate"><MINOR></code> are unpaded numbers and represent the major and minor components of the version. Versions may be arithmetic compared by intrepreting the version string as a decimal number. For this specification version, this value is constant and MUST be <code class="docutils literal notranslate">1.0</code>. Future versions of this schema MUST use a higher version number. Future versions of this schema MUST NOT use the same major version component as other schema version unless its specification is deemed backwards-compatible with them — it can’t change, or extend, any parts of the current specification in such a way as the semantics of the interpreted data differ, or that data valid under the new specification is invalid under the older specification, with the exception of additional properties (errors caused by <code class="docutils literal notranslate">additionalProperties</code>). </td> </tr> <tr class="row-odd"><td>Required</td> <td>True</td> </tr> </tbody> </table> </section> <section id="base-prefix"> <h3><a class="toc-backref" href="#base-prefix" role="doc-backlink"><code class="docutils literal notranslate">base_prefix</code></a></h3> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">string</code></td> </tr> <tr class="row-even"><td>Description</td> <td>Base prefix of the Python installation.Either an absolute path, or a relative path to directory where this file is contained. </td> </tr> <tr class="row-odd"><td>Examples</td> <td><code class="docutils literal notranslate">/usr</code>, <code class="docutils literal notranslate">../..</code>, etc.</td> </tr> <tr class="row-even"><td>Required</td> <td>False</td> </tr> </tbody> </table> </section> <section id="platform"> <h3><a class="toc-backref" href="#platform" role="doc-backlink"><code class="docutils literal notranslate">platform</code></a></h3> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">string</code></td> </tr> <tr class="row-even"><td>Description</td> <td>System platform string.This field SHOULD be equivalent to <code class="docutils literal notranslate">sysconfig.get_platform()</code>. </td> </tr> <tr class="row-odd"><td>Examples</td> <td><ul class="simple"> <li><code class="docutils literal notranslate">linux-x86_64</code></li> <li>etc.</li> </ul> </td> </tr> <tr class="row-even"><td>Required</td> <td>True</td> </tr> </tbody> </table> </section> <section id="language"> <h3><a class="toc-backref" href="#language" role="doc-backlink"><code class="docutils literal notranslate">language</code></a></h3> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">object</code></td> </tr> <tr class="row-even"><td>Description</td> <td>Object containing details related to the Python language specification.In addition to the required keys, implementations may choose to include extra keys with implementation-specific details. </td> </tr> <tr class="row-odd"><td>Required</td> <td>True</td> </tr> <tr class="row-even"><td>Additional properties</td> <td>Not allowed</td> </tr> </tbody> </table> <section id="language-version"> <h4><a class="toc-backref" href="#language-version" role="doc-backlink"><code class="docutils literal notranslate">language.version</code></a></h4> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">string</code></td> </tr> <tr class="row-even"><td>Description</td> <td>String representation the Python language version — a version string consisting only of the major and minor components.This field SHOULD be equivalent to <code class="docutils literal notranslate">sysconfig.get_python_version()</code>. </td> </tr> <tr class="row-odd"><td>Examples</td> <td><code class="docutils literal notranslate">3.14</code>, etc.</td> </tr> <tr class="row-even"><td>Required</td> <td>True</td> </tr> </tbody> </table> </section> <section id="language-version-info"> <h4><a class="toc-backref" href="#language-version-info" role="doc-backlink"><code class="docutils literal notranslate">language.version_info</code></a></h4> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">object</code></td> </tr> <tr class="row-even"><td>Description</td> <td>Object in the format of <a class="reference external" href="https://docs.python.org/3/library/sys.html#sys.version_info" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate">sys.version_info</code></a>.This section SHOULD be equivalent to <a class="reference external" href="https://docs.python.org/3/library/sys.html#sys.version_info" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate">sys.version_info</code></a>. </td> </tr> <tr class="row-odd"><td>Examples</td> <td><ul class="simple"> <li><code class="docutils literal notranslate">{'major': 3, 'minor': 14, 'micro': 1, 'releaselevel': 'final', 'serial': 0}</code></li> <li>etc.</li> </ul> </td> </tr> <tr class="row-even"><td>Required</td> <td>False</td> </tr> <tr class="row-odd"><td>Additional properties</td> <td>Not allowed</td> </tr> </tbody> </table> <section id="language-version-info-major"> <h5><a class="toc-backref" href="#language-version-info-major" role="doc-backlink"><code class="docutils literal notranslate">language.version_info.major</code></a></h5> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">number</code></td> </tr> <tr class="row-even"><td>Required</td> <td>True</td> </tr> </tbody> </table> </section> <section id="language-version-info-minor"> <h5><a class="toc-backref" href="#language-version-info-minor" role="doc-backlink"><code class="docutils literal notranslate">language.version_info.minor</code></a></h5> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">number</code></td> </tr> <tr class="row-even"><td>Required</td> <td>True</td> </tr> </tbody> </table> </section> <section id="language-version-info-micro"> <h5><a class="toc-backref" href="#language-version-info-micro" role="doc-backlink"><code class="docutils literal notranslate">language.version_info.micro</code></a></h5> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">number</code></td> </tr> <tr class="row-even"><td>Required</td> <td>True</td> </tr> </tbody> </table> </section> <section id="language-version-info-releaselevel"> <h5><a class="toc-backref" href="#language-version-info-releaselevel" role="doc-backlink"><code class="docutils literal notranslate">language.version_info.releaselevel</code></a></h5> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">string</code> (enum — <code class="docutils literal notranslate">alpha</code>, <code class="docutils literal notranslate">beta</code>, <code class="docutils literal notranslate">candidate</code>, <code class="docutils literal notranslate">final</code>)</td> </tr> <tr class="row-even"><td>Required</td> <td>True</td> </tr> </tbody> </table> </section> <section id="language-version-info-serial"> <h5><a class="toc-backref" href="#language-version-info-serial" role="doc-backlink"><code class="docutils literal notranslate">language.version_info.serial</code></a></h5> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">number</code></td> </tr> <tr class="row-even"><td>Required</td> <td>True</td> </tr> </tbody> </table> </section> </section> </section> <section id="implementation"> <h3><a class="toc-backref" href="#implementation" role="doc-backlink"><code class="docutils literal notranslate">implementation</code></a></h3> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">object</code></td> </tr> <tr class="row-even"><td>Description</td> <td>Object containing details related to Python implementation.This section SHOULD be equivalent to <a class="reference external" href="https://docs.python.org/3/library/sys.html#sys.implementation" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate">sys.implementation</code></a>. It follows specification defined in PEP 421, meaning that on top of the required keys, implementation-specific keys can also exist, but must be prefixed with an underscore. </td> </tr> <tr class="row-odd"><td>Required</td> <td>True</td> </tr> <tr class="row-even"><td>Additional properties</td> <td>Allowed</td> </tr> </tbody> </table> <section id="implementation-name"> <h4><a class="toc-backref" href="#implementation-name" role="doc-backlink"><code class="docutils literal notranslate">implementation.name</code></a></h4> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">string</code></td> </tr> <tr class="row-even"><td>Description</td> <td>Lower-case name of the Python implementation.</td> </tr> <tr class="row-odd"><td>Examples</td> <td><code class="docutils literal notranslate">cpython</code>, <code class="docutils literal notranslate">pypy</code>, etc.</td> </tr> <tr class="row-even"><td>Required</td> <td>True</td> </tr> </tbody> </table> </section> <section id="implementation-version"> <h4><a class="toc-backref" href="#implementation-version" role="doc-backlink"><code class="docutils literal notranslate">implementation.version</code></a></h4> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">object</code></td> </tr> <tr class="row-even"><td>Description</td> <td>Object in the format of <a class="reference external" href="https://docs.python.org/3/library/sys.html#sys.version_info" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate">sys.version_info</code></a>, containing the implementation version.</td> </tr> <tr class="row-odd"><td>Examples</td> <td><ul class="simple"> <li><code class="docutils literal notranslate">{'major': 3, 'minor': 14, 'micro': 1, 'releaselevel': 'final', 'serial': 0}</code></li> <li><code class="docutils literal notranslate">{'major': 7, 'minor': 3, 'micro': 16, 'releaselevel': 'final', 'serial': 0}</code></li> <li>etc.</li> </ul> </td> </tr> <tr class="row-even"><td>Required</td> <td>True</td> </tr> <tr class="row-odd"><td>Additional properties</td> <td>Not allowed</td> </tr> </tbody> </table> <section id="implementation-version-major"> <h5><a class="toc-backref" href="#implementation-version-major" role="doc-backlink"><code class="docutils literal notranslate">implementation.version.major</code></a></h5> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">number</code></td> </tr> <tr class="row-even"><td>Required</td> <td>True</td> </tr> </tbody> </table> </section> <section id="implementation-version-minor"> <h5><a class="toc-backref" href="#implementation-version-minor" role="doc-backlink"><code class="docutils literal notranslate">implementation.version.minor</code></a></h5> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">number</code></td> </tr> <tr class="row-even"><td>Required</td> <td>True</td> </tr> </tbody> </table> </section> <section id="implementation-version-micro"> <h5><a class="toc-backref" href="#implementation-version-micro" role="doc-backlink"><code class="docutils literal notranslate">implementation.version.micro</code></a></h5> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">number</code></td> </tr> <tr class="row-even"><td>Required</td> <td>True</td> </tr> </tbody> </table> </section> <section id="implementation-version-releaselevel"> <h5><a class="toc-backref" href="#implementation-version-releaselevel" role="doc-backlink"><code class="docutils literal notranslate">implementation.version.releaselevel</code></a></h5> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">string</code> (enum — <code class="docutils literal notranslate">alpha</code>, <code class="docutils literal notranslate">beta</code>, <code class="docutils literal notranslate">candidate</code>, <code class="docutils literal notranslate">final</code>)</td> </tr> <tr class="row-even"><td>Required</td> <td>True</td> </tr> </tbody> </table> </section> <section id="implementation-version-serial"> <h5><a class="toc-backref" href="#implementation-version-serial" role="doc-backlink"><code class="docutils literal notranslate">implementation.version.serial</code></a></h5> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">number</code></td> </tr> <tr class="row-even"><td>Required</td> <td>True</td> </tr> </tbody> </table> </section> </section> </section> <section id="interpreter"> <h3><a class="toc-backref" href="#interpreter" role="doc-backlink"><code class="docutils literal notranslate">interpreter</code></a></h3> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">object</code></td> </tr> <tr class="row-even"><td>Description</td> <td>Object containing details Python interpreter.This section MUST be present if the Python installation provides an interpreter binary, otherwise this section will be missing. </td> </tr> <tr class="row-odd"><td>Required</td> <td>False</td> </tr> <tr class="row-even"><td>Additional properties</td> <td>Not allowed</td> </tr> </tbody> </table> <section id="interpreter-path"> <h4><a class="toc-backref" href="#interpreter-path" role="doc-backlink"><code class="docutils literal notranslate">interpreter.path</code></a></h4> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">string</code></td> </tr> <tr class="row-even"><td>Description</td> <td>The path to the Python interprer. Either an absolute path, or a relative path to the path defined in the <code class="docutils literal notranslate">base_prefix</code> key.</td> </tr> <tr class="row-odd"><td>Examples</td> <td><ul class="simple"> <li><code class="docutils literal notranslate">/usr/bin/python</code></li> <li><code class="docutils literal notranslate">bin/python</code></li> <li>etc.</li> </ul> </td> </tr> <tr class="row-even"><td>Required</td> <td>True</td> </tr> </tbody> </table> </section> </section> <section id="abi"> <h3><a class="toc-backref" href="#abi" role="doc-backlink"><code class="docutils literal notranslate">abi</code></a></h3> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">object</code></td> </tr> <tr class="row-even"><td>Description</td> <td>Object containing details related to ABI.</td> </tr> <tr class="row-odd"><td>Required</td> <td>False</td> </tr> <tr class="row-even"><td>Additional properties</td> <td>Not allowed</td> </tr> </tbody> </table> <section id="abi-flags"> <h4><a class="toc-backref" href="#abi-flags" role="doc-backlink"><code class="docutils literal notranslate">abi.flags</code></a></h4> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">array</code></td> </tr> <tr class="row-even"><td>Description</td> <td>Build configuration flags, used to calculate the extension suffix.The flags MUST be defined in the order they appear on the extension suffix. </td> </tr> <tr class="row-odd"><td>Examples</td> <td><code class="docutils literal notranslate">['t', 'd']</code>, etc.</td> </tr> <tr class="row-even"><td>Required</td> <td>True</td> </tr> </tbody> </table> </section> <section id="abi-extension-suffix"> <h4><a class="toc-backref" href="#abi-extension-suffix" role="doc-backlink"><code class="docutils literal notranslate">abi.extension_suffix</code></a></h4> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">string</code></td> </tr> <tr class="row-even"><td>Description</td> <td>Suffix used for extensions built against the current implementation version.This field MUST be present if the Python implementation supports extensions, otherwise this entry will be missing. </td> </tr> <tr class="row-odd"><td>Examples</td> <td><ul class="simple"> <li><code class="docutils literal notranslate">.cpython-314-x86_64-linux-gnu.so</code></li> <li>etc.</li> </ul> </td> </tr> <tr class="row-even"><td>Required</td> <td>True</td> </tr> </tbody> </table> </section> <section id="abi-stable-abi-suffix"> <h4><a class="toc-backref" href="#abi-stable-abi-suffix" role="doc-backlink"><code class="docutils literal notranslate">abi.stable_abi_suffix</code></a></h4> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">string</code></td> </tr> <tr class="row-even"><td>Description</td> <td>Suffix used for extensions built against the stable ABI.This field MUST be present if the Python implementation has a stable ABI extension suffix, otherwise this entry will be missing. </td> </tr> <tr class="row-odd"><td>Examples</td> <td><code class="docutils literal notranslate">.abi3.so</code>, etc.</td> </tr> <tr class="row-even"><td>Required</td> <td>False</td> </tr> </tbody> </table> </section> </section> <section id="suffixes"> <h3><a class="toc-backref" href="#suffixes" role="doc-backlink"><code class="docutils literal notranslate">suffixes</code></a></h3> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">object</code></td> </tr> <tr class="row-even"><td>Description</td> <td>Valid module suffixes grouped by type.This section SHOULD be equivalent to the <code class="docutils literal notranslate">importlib.machinery.*_SUFFIXES</code> attributes, if the implementation provides such suffixes. However, if the Python implementation does not provide suffixes of the kind specified by any of the attributes, the equivalent sub-section is not required to be present. Additionally, if a Python implementation provides extension kinds other than the ones listed on <code class="docutils literal notranslate">importlib.machinery</code> module, they MAY add a sub-section for them. </td> </tr> <tr class="row-odd"><td>Examples</td> <td><ul class="simple"> <li><code class="docutils literal notranslate">{'source': ['.py'], 'bytecode': ['.pyc'], 'optimized_bytecode': ['.pyc'], 'debug_bytecode': ['.pyc'], 'extensions': ['.cpython-313-x86_64-linux-gnu.so', '.abi3.so', '.so']}</code></li> <li>etc.</li> </ul> </td> </tr> <tr class="row-even"><td>Required</td> <td>False</td> </tr> <tr class="row-odd"><td>Additional properties</td> <td>Allowed</td> </tr> </tbody> </table> </section> <section id="libpython"> <h3><a class="toc-backref" href="#libpython" role="doc-backlink"><code class="docutils literal notranslate">libpython</code></a></h3> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">object</code></td> </tr> <tr class="row-even"><td>Description</td> <td>Object containing details related to the <code class="docutils literal notranslate">libpython</code> library.This section MUST by present if Python installation provides a <code class="docutils literal notranslate">libpython</code> library, otherwise this section will be missing. </td> </tr> <tr class="row-odd"><td>Required</td> <td>False</td> </tr> <tr class="row-even"><td>Additional properties</td> <td>Not allowed</td> </tr> </tbody> </table> <section id="libpython-dynamic"> <h4><a class="toc-backref" href="#libpython-dynamic" role="doc-backlink"><code class="docutils literal notranslate">libpython.dynamic</code></a></h4> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">string</code></td> </tr> <tr class="row-even"><td>Description</td> <td>The path to the dynamic <code class="docutils literal notranslate">libpython</code> library. Either an absolute path, or a relative path to the path defined in the <code class="docutils literal notranslate">base_prefix</code> key.This field MUST be present if the Python installation provides a dynamic <code class="docutils literal notranslate">libpython</code> library, otherwise this entry will be missing. </td> </tr> <tr class="row-odd"><td>Examples</td> <td><ul class="simple"> <li><code class="docutils literal notranslate">/usr/lib/libpython3.14.so.1.0</code></li> <li><code class="docutils literal notranslate">lib/libpython3.14.so.1.0</code></li> <li>etc.</li> </ul> </td> </tr> <tr class="row-even"><td>Required</td> <td>False</td> </tr> </tbody> </table> </section> <section id="libpython-dynamic-stableabi"> <h4><a class="toc-backref" href="#libpython-dynamic-stableabi" role="doc-backlink"><code class="docutils literal notranslate">libpython.dynamic_stableabi</code></a></h4> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">string</code></td> </tr> <tr class="row-even"><td>Description</td> <td>The path to the dynamic <code class="docutils literal notranslate">libpython</code> library for the stable ABI. Either an absolute path, or a relative path to the path defined in the <code class="docutils literal notranslate">base_prefix</code> key.This field MUST be present if the Python installation provides a dynamic <code class="docutils literal notranslate">libpython</code> library, otherwise this entry will be missing. </td> </tr> <tr class="row-odd"><td>Examples</td> <td><ul class="simple"> <li><code class="docutils literal notranslate">/usr/lib/libpython3.so</code></li> <li><code class="docutils literal notranslate">lib/libpython3.so</code></li> <li>etc.</li> </ul> </td> </tr> <tr class="row-even"><td>Required</td> <td>False</td> </tr> </tbody> </table> </section> <section id="libpython-static"> <h4><a class="toc-backref" href="#libpython-static" role="doc-backlink"><code class="docutils literal notranslate">libpython.static</code></a></h4> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">string</code></td> </tr> <tr class="row-even"><td>Description</td> <td>The path to the static <code class="docutils literal notranslate">libpython</code> library. Either an absolute path, or a relative path to the path defined in the <code class="docutils literal notranslate">base_prefix</code> key.This field MUST be present if the Python installation provides a static <code class="docutils literal notranslate">libpython</code> library, otherwise this entry will be missing. </td> </tr> <tr class="row-odd"><td>Examples</td> <td><ul class="simple"> <li><code class="docutils literal notranslate">/usr/lib/python3.14/config-3.14-x86_64-linux-gnu/libpython3.14.a</code></li> <li><code class="docutils literal notranslate">lib/python3.14/config-3.14-x86_64-linux-gnu/libpython3.14.a</code></li> <li>etc.</li> </ul> </td> </tr> <tr class="row-even"><td>Required</td> <td>False</td> </tr> </tbody> </table> </section> <section id="libpython-link-to-libpython"> <h4><a class="toc-backref" href="#libpython-link-to-libpython" role="doc-backlink"><code class="docutils literal notranslate">libpython.link_to_libpython</code></a></h4> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">boolean</code></td> </tr> <tr class="row-even"><td>Description</td> <td>Should extensions built against a dynamic <code class="docutils literal notranslate">libpython</code> link to it?This field MUST be present if the Python installation provides a dynamic <code class="docutils literal notranslate">libpython</code> library, otherwise this entry will be missing. </td> </tr> <tr class="row-odd"><td>Required</td> <td>False</td> </tr> </tbody> </table> </section> </section> <section id="c-api"> <h3><a class="toc-backref" href="#c-api" role="doc-backlink"><code class="docutils literal notranslate">c_api</code></a></h3> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">object</code></td> </tr> <tr class="row-even"><td>Description</td> <td>Object containing details related to the Python C API, if available.This section MUST be present if the Python implementation provides a C API, otherwise this section will be missing. </td> </tr> <tr class="row-odd"><td>Required</td> <td>False</td> </tr> <tr class="row-even"><td>Additional properties</td> <td>Not allowed</td> </tr> </tbody> </table> <section id="c-api-headers"> <h4><a class="toc-backref" href="#c-api-headers" role="doc-backlink"><code class="docutils literal notranslate">c_api.headers</code></a></h4> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">string</code></td> </tr> <tr class="row-even"><td>Description</td> <td>The path to the C API headers. Either an absolute path, or a relative path to the path defined in the <code class="docutils literal notranslate">base_prefix</code> key.</td> </tr> <tr class="row-odd"><td>Examples</td> <td><ul class="simple"> <li><code class="docutils literal notranslate">/usr/include/python3.14</code></li> <li><code class="docutils literal notranslate">include/python3.14</code></li> <li>etc.</li> </ul> </td> </tr> <tr class="row-even"><td>Required</td> <td>True</td> </tr> </tbody> </table> </section> <section id="c-api-pkgconfig-path"> <h4><a class="toc-backref" href="#c-api-pkgconfig-path" role="doc-backlink"><code class="docutils literal notranslate">c_api.pkgconfig_path</code></a></h4> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">string</code></td> </tr> <tr class="row-even"><td>Description</td> <td>The path to the pkg-config definition files. Either an absolute path, or a relative path to the path defined in the <code class="docutils literal notranslate">base_prefix</code> key.This field MUST be present if the Python implementation provides pkg-config definition files for the C API, otherwise this section will be missing. </td> </tr> <tr class="row-odd"><td>Examples</td> <td><ul class="simple"> <li><code class="docutils literal notranslate">/usr/lib/pkgconfig</code></li> <li><code class="docutils literal notranslate">lib/pkgconfig</code></li> <li>etc.</li> </ul> </td> </tr> <tr class="row-even"><td>Required</td> <td>False</td> </tr> </tbody> </table> </section> </section> <section id="arbitrary-data"> <h3><a class="toc-backref" href="#arbitrary-data" role="doc-backlink"><code class="docutils literal notranslate">arbitrary_data</code></a></h3> <table class="docutils align-default"> <colgroup> <col style="width: 25.0%" /> <col style="width: 75.0%" /> </colgroup> <tbody> <tr class="row-odd"><td>Type</td> <td><code class="docutils literal notranslate">object</code></td> </tr> <tr class="row-even"><td>Description</td> <td>Object containing extra arbitrary data.This is meant to be used as an escape-hatch, to include any relevant data that is not covered by this specification. Implamentations may choose what data to provide in this section. </td> </tr> <tr class="row-odd"><td>Required</td> <td>False</td> </tr> <tr class="row-even"><td>Additional properties</td> <td>Allowed</td> </tr> </tbody> </table> </section> </section> <section id="example"> <h2><a class="toc-backref" href="#example" role="doc-backlink">Example</a></h2> <div class="highlight-json notranslate"><div class="highlight"><pre> 1{ 2 "schema_version": "1.0", 3 "base_prefix": "/usr", 4 "platform": "linux-x86_64", 5 "language": { 6 "version": "3.14", 7 "version_info": { 8 "major": 3, 9 "minor": 14, 10 "micro": 0, 11 "releaselevel": "alpha", 12 "serial": 0 13 } 14 }, 15 "implementation": { 16 "name": "cpython", 17 "version": { 18 "major": 3, 19 "minor": 14, 20 "micro": 0, 21 "releaselevel": "alpha", 22 "serial": 0 23 }, 24 "hexversion": 51249312, 25 "cache_tag": "cpython-314", 26 "_multiarch": "x86_64-linux-gnu" 27 }, 28 "interpreter": { 29 "path": "/usr/bin/python" 30 }, 31 "abi": { 32 "flags": ["t", "d"], 33 "extension_suffix": ".cpython-314-x86_64-linux-gnu.so", 34 "stable_abi_suffix": ".abi3.so" 35 }, 36 "suffixes": { 37 "source": [".py"], 38 "bytecode": [".pyc"], 39 "optimized_bytecode": [".pyc"], 40 "debug_bytecode": [".pyc"], 41 "extensions": [".cpython-314-x86_64-linux-gnu.so", ".abi3.so", ".so"] 42 }, 43 "libpython": { 44 "dynamic": "/usr/lib/libpython3.14.so.1.0", 45 "dynamic_stableabi": "/usr/lib/libpython3.so", 46 "static": "/usr/lib/python3.14/config-3.14-x86_64-linux-gnu/libpython3.14.a", 47 "link_to_libpython": true 48 }, 49 "c_api": { 50 "headers": "/usr/include/python3.14", 51 "pkgconfig_path": "/usr/lib/pkgconfig" 52 } 53} </pre></div> </div> </section> <section id="json-schema"> <h2><a class="toc-backref" href="#json-schema" role="doc-backlink">JSON Schema</a></h2> <div class="highlight-json notranslate"><div class="highlight"><pre> 1{ 2 "$schema": "https://json-schema.org/draft/2020-12/schema", 3 "$id": "https://github.com/python/peps/blob/main/peps/pep-0739/python-build-info-v1.0.schema.json", 4 "type": "object", 5 "title": "Static description file for the build details of Python installations", 6 "required": [ 7 "schema_version", 8 "platform", 9 "language", 10 "implementation" 11 ], 12 "additionalProperties": false, 13 "properties": { 14 "schema_version": { 15 "type": "string", 16 "description": "Schema version.\n\nThis is a string following the format ``<MAJOR>.<MINOR>``, where ``<MAJOR>`` and ``<MINOR>`` are unpaded numbers and represent the **major** and **minor** components of the version. Versions may be arithmetic compared by intrepreting the version string as a decimal number.\n\nFor this specification version, this value is constant and MUST be ``1.0``.\n\nFuture versions of this schema MUST use a higher version number. Future versions of this schema MUST NOT use the same **major** version component as other schema version unless its specification is deemed backwards-compatible with them — it can't change, or extend, any parts of the current specification in such a way as the semantics of the interpreted data differ, or that data valid under the new specification is invalid under the older specification, with the exception of additional properties (errors caused by ``additionalProperties``).", 17 "const": "1.0" 18 }, 19 "base_prefix": { 20 "type": "string", 21 "description": "Base prefix of the Python installation.\n\nEither an absolute path, or a relative path to directory where this file is contained.", 22 "examples": [ 23 "/usr", 24 "../.." 25 ] 26 }, 27 "platform": { 28 "type": "string", 29 "description": "System platform string.\n\nThis field SHOULD be equivalent to ``sysconfig.get_platform()``.", 30 "examples": [ 31 "linux-x86_64" 32 ] 33 }, 34 "language": { 35 "type": "object", 36 "description": "Object containing details related to the Python language specification.\n\nIn addition to the required keys, implementations may choose to include extra keys with implementation-specific details.", 37 "required": [ 38 "version" 39 ], 40 "additionalProperties": false, 41 "properties": { 42 "version": { 43 "type": "string", 44 "description": "String representation the Python language version — a version string consisting only of the *major* and *minor* components.\n\nThis field SHOULD be equivalent to ``sysconfig.get_python_version()``.", 45 "examples": ["3.14"] 46 }, 47 "version_info": { 48 "type": "object", 49 "description": "Object in the format of :py:data:`sys.version_info`.\n\nThis section SHOULD be equivalent to :py:data:`sys.version_info`.", 50 "required": ["major", "minor", "micro", "releaselevel", "serial"], 51 "additionalProperties": false, 52 "examples": [ 53 { 54 "major": 3, 55 "minor": 14, 56 "micro": 1, 57 "releaselevel": "final", 58 "serial": 0 59 } 60 ], 61 "properties": { 62 "major": { 63 "type": "number" 64 }, 65 "minor": { 66 "type": "number" 67 }, 68 "micro": { 69 "type": "number" 70 }, 71 "releaselevel": { 72 "type": "string", 73 "enum": ["alpha", "beta", "candidate", "final"] 74 }, 75 "serial": { 76 "type": "number" 77 } 78 } 79 } 80 } 81 }, 82 "implementation": { 83 "type": "object", 84 "description": "Object containing details related to Python implementation.\n\nThis section SHOULD be equivalent to :py:data:`sys.implementation`. It follows specification defined in PEP 421, meaning that on top of the required keys, implementation-specific keys can also exist, but must be prefixed with an underscore.", 85 "required": [ 86 "name", 87 "version", 88 "hexversion", 89 "cache_tag" 90 ], 91 "additionalProperties": true, 92 "properties": { 93 "name": { 94 "type": "string", 95 "description": "Lower-case name of the Python implementation.", 96 "examples": ["cpython", "pypy"] 97 }, 98 "version": { 99 "type": "object", 100 "description": "Object in the format of :py:data:`sys.version_info`, containing the implementation version.", 101 "required": ["major", "minor", "micro", "releaselevel", "serial"], 102 "additionalProperties": false, 103 "examples": [ 104 { 105 "major": 3, 106 "minor": 14, 107 "micro": 1, 108 "releaselevel": "final", 109 "serial": 0 110 }, 111 { 112 "major": 7, 113 "minor": 3, 114 "micro": 16, 115 "releaselevel": "final", 116 "serial": 0 117 } 118 ], 119 "properties": { 120 "major": { 121 "type": "number" 122 }, 123 "minor": { 124 "type": "number" 125 }, 126 "micro": { 127 "type": "number" 128 }, 129 "releaselevel": { 130 "type": "string", 131 "enum": ["alpha", "beta", "candidate", "final"] 132 }, 133 "serial": { 134 "type": "number" 135 } 136 } 137 } 138 } 139 }, 140 "interpreter": { 141 "type": "object", 142 "description": "Object containing details Python interpreter.\n\nThis section MUST be present if the Python installation provides an interpreter binary, otherwise this section will be missing.", 143 "required": [ 144 "path" 145 ], 146 "additionalProperties": false, 147 "properties": { 148 "path": { 149 "type": "string", 150 "description": "The path to the Python interprer. Either an absolute path, or a relative path to the path defined in the ``base_prefix`` key.", 151 "examples": [ 152 "/usr/bin/python", 153 "bin/python" 154 ] 155 } 156 } 157 }, 158 "abi": { 159 "type": "object", 160 "description": "Object containing details related to ABI.", 161 "required": [ 162 "flags", 163 "extension_suffix" 164 ], 165 "additionalProperties": false, 166 "properties": { 167 "flags": { 168 "type": "array", 169 "description": "Build configuration flags, used to calculate the extension suffix.\n\nThe flags MUST be defined in the order they appear on the extension suffix.", 170 "additionalProperties": true, 171 "examples": [ 172 ["t", "d"] 173 ] 174 }, 175 "extension_suffix": { 176 "type": "string", 177 "description": "Suffix used for extensions built against the current implementation version.\n\nThis field MUST be present if the Python implementation supports extensions, otherwise this entry will be missing.", 178 "examples": [ 179 ".cpython-314-x86_64-linux-gnu.so" 180 ] 181 }, 182 "stable_abi_suffix": { 183 "type": "string", 184 "description": "Suffix used for extensions built against the stable ABI.\n\nThis field MUST be present if the Python implementation has a stable ABI extension suffix, otherwise this entry will be missing.", 185 "examples": [ 186 ".abi3.so" 187 ] 188 } 189 } 190 }, 191 "suffixes": { 192 "type": "object", 193 "description": "Valid module suffixes grouped by type.\n\nThis section SHOULD be equivalent to the ``importlib.machinery.*_SUFFIXES`` attributes, if the implementation provides such suffixes. However, if the Python implementation does not provide suffixes of the kind specified by any of the attributes, the equivalent sub-section is not required to be present. Additionally, if a Python implementation provides extension kinds other than the ones listed on ``importlib.machinery`` module, they MAY add a sub-section for them.", 194 "examples": [ 195 { 196 "source": [".py"], 197 "bytecode": [".pyc"], 198 "optimized_bytecode": [".pyc"], 199 "debug_bytecode": [".pyc"], 200 "extensions": [".cpython-313-x86_64-linux-gnu.so", ".abi3.so", ".so"] 201 } 202 ] 203 }, 204 "libpython": { 205 "type": "object", 206 "description": "Object containing details related to the ``libpython`` library.\n\nThis section MUST by present if Python installation provides a ``libpython`` library, otherwise this section will be missing.", 207 "additionalProperties": false, 208 "properties": { 209 "dynamic": { 210 "type": "string", 211 "description": "The path to the dynamic ``libpython`` library. Either an absolute path, or a relative path to the path defined in the ``base_prefix`` key.\n\nThis field MUST be present if the Python installation provides a dynamic ``libpython`` library, otherwise this entry will be missing.", 212 "examples": [ 213 "/usr/lib/libpython3.14.so.1.0", 214 "lib/libpython3.14.so.1.0" 215 ] 216 }, 217 "dynamic_stableabi": { 218 "type": "string", 219 "description": "The path to the dynamic ``libpython`` library for the stable ABI. Either an absolute path, or a relative path to the path defined in the ``base_prefix`` key.\n\nThis field MUST be present if the Python installation provides a dynamic ``libpython`` library, otherwise this entry will be missing.", 220 "examples": [ 221 "/usr/lib/libpython3.so", 222 "lib/libpython3.so" 223 ] 224 }, 225 "static": { 226 "type": "string", 227 "description": "The path to the static ``libpython`` library. Either an absolute path, or a relative path to the path defined in the ``base_prefix`` key.\n\nThis field MUST be present if the Python installation provides a static ``libpython`` library, otherwise this entry will be missing.", 228 "examples": [ 229 "/usr/lib/python3.14/config-3.14-x86_64-linux-gnu/libpython3.14.a", 230 "lib/python3.14/config-3.14-x86_64-linux-gnu/libpython3.14.a" 231 ] 232 }, 233 "link_to_libpython": { 234 "type": "boolean", 235 "description": "Should extensions built against a dynamic ``libpython`` link to it?\n\nThis field MUST be present if the Python installation provides a dynamic ``libpython`` library, otherwise this entry will be missing." 236 } 237 } 238 }, 239 "c_api": { 240 "type": "object", 241 "description": "Object containing details related to the Python C API, if available.\n\nThis section MUST be present if the Python implementation provides a C API, otherwise this section will be missing.", 242 "required": [ 243 "headers" 244 ], 245 "additionalProperties": false, 246 "properties": { 247 "headers": { 248 "type": "string", 249 "description": "The path to the C API headers. Either an absolute path, or a relative path to the path defined in the ``base_prefix`` key.", 250 "examples": [ 251 "/usr/include/python3.14", 252 "include/python3.14" 253 ] 254 }, 255 "pkgconfig_path": { 256 "type": "string", 257 "description": "The path to the pkg-config definition files. Either an absolute path, or a relative path to the path defined in the ``base_prefix`` key.\n\nThis field MUST be present if the Python implementation provides pkg-config definition files for the C API, otherwise this section will be missing.", 258 "examples": [ 259 "/usr/lib/pkgconfig", 260 "lib/pkgconfig" 261 ] 262 } 263 } 264 }, 265 "arbitrary_data": { 266 "type": "object", 267 "description": "Object containing extra arbitrary data.\n\nThis is meant to be used as an escape-hatch, to include any relevant data that is not covered by this specification. Implamentations may choose what data to provide in this section.", 268 "additionalProperties": true 269 } 270 } 271} </pre></div> </div> </section> <section id="rejected-ideas"> <h2><a class="toc-backref" href="#rejected-ideas" role="doc-backlink">Rejected Ideas</a></h2> <section id="having-a-larger-scope"> <h3><a class="toc-backref" href="#having-a-larger-scope" role="doc-backlink">Having a larger scope</a></h3> One of the main requests in the discussion of this PEP was the inclusion of other kind of information, such as the <code class="docutils literal notranslate">site-packages</code> path. It is the opinion of the PEP authors that information regarding the Python environment should be provided by a separate file, creating the a clear separation between the build details, which should be immutable across any interpreter instance, and details that can change, such as environment details. </section> </section> <section id="copyright"> <h2><a class="toc-backref" href="#copyright" role="doc-backlink">Copyright</a></h2> This document is placed in the public domain or under the CC0-1.0-Universal license, whichever is more permissive. </section> </section> <hr class="docutils" /> Source: <a class="reference external" href="https://github.com/python/peps/blob/main/peps/pep-0739.rst">https://github.com/python/peps/blob/main/peps/pep-0739.rst</a> Last modified: <a class="reference external" href="https://github.com/python/peps/commits/main/peps/pep-0739.rst">2024-11-06 17:11:55 GMT</a> </article> <nav id="pep-sidebar"> <h2>Contents</h2> <ul> <li><a class="reference internal" href="#abstract">Abstract</a></li> <li><a class="reference internal" href="#rationale">Rationale</a></li> <li><a class="reference internal" href="#scope">Scope</a></li> <li><a class="reference internal" href="#location">Location</a></li> <li><a class="reference internal" href="#format">Format</a><ul> <li><a class="reference internal" href="#schema-version"><code class="docutils literal notranslate">schema_version</code></a></li> <li><a class="reference internal" href="#base-prefix"><code class="docutils literal notranslate">base_prefix</code></a></li> <li><a class="reference internal" href="#platform"><code class="docutils literal notranslate">platform</code></a></li> <li><a class="reference internal" href="#language"><code class="docutils literal notranslate">language</code></a><ul> <li><a class="reference internal" href="#language-version"><code class="docutils literal notranslate">language.version</code></a></li> <li><a class="reference internal" href="#language-version-info"><code class="docutils literal notranslate">language.version_info</code></a><ul> <li><a class="reference internal" href="#language-version-info-major"><code class="docutils literal notranslate">language.version_info.major</code></a></li> <li><a class="reference internal" href="#language-version-info-minor"><code class="docutils literal notranslate">language.version_info.minor</code></a></li> <li><a class="reference internal" href="#language-version-info-micro"><code class="docutils literal notranslate">language.version_info.micro</code></a></li> <li><a class="reference internal" href="#language-version-info-releaselevel"><code class="docutils literal notranslate">language.version_info.releaselevel</code></a></li> <li><a class="reference internal" href="#language-version-info-serial"><code class="docutils literal notranslate">language.version_info.serial</code></a></li> </ul> </li> </ul> </li> <li><a class="reference internal" href="#implementation"><code class="docutils literal notranslate">implementation</code></a><ul> <li><a class="reference internal" href="#implementation-name"><code class="docutils literal notranslate">implementation.name</code></a></li> <li><a class="reference internal" href="#implementation-version"><code class="docutils literal notranslate">implementation.version</code></a><ul> <li><a class="reference internal" href="#implementation-version-major"><code class="docutils literal notranslate">implementation.version.major</code></a></li> <li><a class="reference internal" href="#implementation-version-minor"><code class="docutils literal notranslate">implementation.version.minor</code></a></li> <li><a class="reference internal" href="#implementation-version-micro"><code class="docutils literal notranslate">implementation.version.micro</code></a></li> <li><a class="reference internal" href="#implementation-version-releaselevel"><code class="docutils literal notranslate">implementation.version.releaselevel</code></a></li> <li><a class="reference internal" href="#implementation-version-serial"><code class="docutils literal notranslate">implementation.version.serial</code></a></li> </ul> </li> </ul> </li> <li><a class="reference internal" href="#interpreter"><code class="docutils literal notranslate">interpreter</code></a><ul> <li><a class="reference internal" href="#interpreter-path"><code class="docutils literal notranslate">interpreter.path</code></a></li> </ul> </li> <li><a class="reference internal" href="#abi"><code class="docutils literal notranslate">abi</code></a><ul> <li><a class="reference internal" href="#abi-flags"><code class="docutils literal notranslate">abi.flags</code></a></li> <li><a class="reference internal" href="#abi-extension-suffix"><code class="docutils literal notranslate">abi.extension_suffix</code></a></li> <li><a class="reference internal" href="#abi-stable-abi-suffix"><code class="docutils literal notranslate">abi.stable_abi_suffix</code></a></li> </ul> </li> <li><a class="reference internal" href="#suffixes"><code class="docutils literal notranslate">suffixes</code></a></li> <li><a class="reference internal" href="#libpython"><code class="docutils literal notranslate">libpython</code></a><ul> <li><a class="reference internal" href="#libpython-dynamic"><code class="docutils literal notranslate">libpython.dynamic</code></a></li> <li><a class="reference internal" href="#libpython-dynamic-stableabi"><code class="docutils literal notranslate">libpython.dynamic_stableabi</code></a></li> <li><a class="reference internal" href="#libpython-static"><code class="docutils literal notranslate">libpython.static</code></a></li> <li><a class="reference internal" href="#libpython-link-to-libpython"><code class="docutils literal notranslate">libpython.link_to_libpython</code></a></li> </ul> </li> <li><a class="reference internal" href="#c-api"><code class="docutils literal notranslate">c_api</code></a><ul> <li><a class="reference internal" href="#c-api-headers"><code class="docutils literal notranslate">c_api.headers</code></a></li> <li><a class="reference internal" href="#c-api-pkgconfig-path"><code class="docutils literal notranslate">c_api.pkgconfig_path</code></a></li> </ul> </li> <li><a class="reference internal" href="#arbitrary-data"><code class="docutils literal notranslate">arbitrary_data</code></a></li> </ul> </li> <li><a class="reference internal" href="#example">Example</a></li> <li><a class="reference internal" href="#json-schema">JSON Schema</a></li> <li><a class="reference internal" href="#rejected-ideas">Rejected Ideas</a><ul> <li><a class="reference internal" href="#having-a-larger-scope">Having a larger scope</a></li> </ul> </li> <li><a class="reference internal" href="#copyright">Copyright</a></li> </ul> <a id="source" href="https://github.com/python/peps/blob/main/peps/pep-0739.rst">Page Source (GitHub)</a> </nav> </section> <script src="../_static/colour_scheme.js"></script> <script src="../_static/wrap_tables.js"></script> <script src="../_static/sticky_banner.js"></script> </body> </html>