Skip to content

gh-138489: Install build-details.json on Windows#138490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
AA-Turner wants to merge 13 commits into from
Closed

gh-138489: Install build-details.json on Windows #138490

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
1901e80
Install ``build-details.json`` on Windows
AA-Turner Sep 3, 2025
dbe1cbd
Update python.vcxproj
AA-Turner Sep 4, 2025
c80344c
Fix ```--relative-paths``
AA-Turner Sep 4, 2025
ee39ea7
Specify encoding when writing file
AA-Turner Sep 4, 2025
f5f0548
Add test for ``--relative-paths``
AA-Turner Sep 4, 2025
fdba9f0
Lint (splitroot requires 3.12)
AA-Turner Sep 4, 2025
6a2cc71
Revert relative-path changes.
AA-Turner Sep 4, 2025
bd9bf46
Merge branch 'main' into pep739-windows
AA-Turner Sep 15, 2025
8d58be4
Regenerate build-details.json via PC\layout\
AA-Turner Sep 16, 2025
a927601
Fix the generated data for Windows
AA-Turner Sep 16, 2025
d743693
Fail gracefully
AA-Turner Sep 16, 2025
d18f70e
bin the type statements
AA-Turner Sep 16, 2025
57f3b26
yet more linting banality
AA-Turner Sep 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/mypy.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ on:
- "Tools/build/check_warnings.py"
- "Tools/build/compute-changes.py"
- "Tools/build/deepfreeze.py"
- "Tools/build/generate-build-details.py"
- "Tools/build/generate_build_details.py"
- "Tools/build/generate_sbom.py"
- "Tools/build/generate_stdlib_module_names.py"
- "Tools/build/mypy.ini"
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,6 +45,8 @@ gmon.out
.pytest_cache/
.ruff_cache/
.DS_Store
__install__.json
build-details.json

*.exe

Expand Down
39 changes: 13 additions & 26 deletions Lib/test/test_build_details.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,18 @@
import importlib
import json
import os
import os.path
import sys
import sysconfig
import string
import unittest
from pathlib import Path

from test.support import is_android, is_apple_mobile, is_wasm32

BASE_PATH = Path(
__file__, # Lib/test/test_build_details.py
'..', # Lib/test
'..', # Lib
'..', # <src/install dir>
).resolve()
MODULE_PATH = BASE_PATH / 'Tools' / 'build' / 'generate-build-details.py'
from test.test_tools import imports_under_tool

try:
# Import "generate-build-details.py" as "generate_build_details"
spec = importlib.util.spec_from_file_location(
"generate_build_details", MODULE_PATH
)
generate_build_details = importlib.util.module_from_spec(spec)
sys.modules["generate_build_details"] = generate_build_details
spec.loader.exec_module(generate_build_details)
except (FileNotFoundError, ImportError):
with imports_under_tool('build'):
import generate_build_details
except ImportError:
generate_build_details = None


Expand DownExpand Up@@ -116,18 +102,20 @@ def test_implementation(self):
)


@unittest.skipIf(os.name != 'posix', 'Feature only implemented on POSIX right now')
@unittest.skipIf(is_wasm32, 'Feature not available on WebAssembly builds')
class CPythonBuildDetailsTests(unittest.TestCase, FormatTestsBase):
"""Test CPython's install details file implementation."""

@property
def location(self):
if sysconfig.is_python_build():
projectdir = sysconfig.get_config_var('projectbase')
pybuilddir = os.path.join(projectdir, 'pybuilddir.txt')
with open(pybuilddir, encoding='utf-8') as f:
dirname = os.path.join(projectdir, f.read())
if sys.platform == 'win32':
dirname = sysconfig.get_config_var('BINDIR')
else:
projectdir = sysconfig.get_config_var('projectbase')
pybuilddir = os.path.join(projectdir, 'pybuilddir.txt')
with open(pybuilddir, encoding='utf-8') as f:
dirname = os.path.join(projectdir, f.read())
else:
dirname = sysconfig.get_path('stdlib')
return os.path.join(dirname, 'build-details.json')
Expand DownExpand Up@@ -176,9 +164,8 @@ def test_c_api(self):

@unittest.skipIf(
generate_build_details is None,
"Failed to import generate-build-details"
"Failed to import generate_build_details",
)
@unittest.skipIf(os.name != 'posix', 'Feature only implemented on POSIX right now')
@unittest.skipIf(is_wasm32, 'Feature not available on WebAssembly builds')
class BuildDetailsRelativePathsTests(unittest.TestCase):
Comment thread
AA-Turner marked this conversation as resolved.
@property
Expand All@@ -189,7 +176,7 @@ def build_details_absolute_paths(self):
@property
def build_details_relative_paths(self):
data = self.build_details_absolute_paths
generate_build_details.make_paths_relative(data, config_path=None)
generate_build_details.make_paths_relative(data, base_path=None)
return data

def test_round_trip(self):
Expand Down
2 changes: 1 addition & 1 deletion Makefile.pre.in
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1004,7 +1004,7 @@ pybuilddir.txt: $(PYTHON_FOR_BUILD_DEPS)
fi

build-details.json: pybuilddir.txt
$(RUNSHARED) $(PYTHON_FOR_BUILD) $(srcdir)/Tools/build/generate-build-details.py `cat pybuilddir.txt`/build-details.json
$(RUNSHARED) $(PYTHON_FOR_BUILD) $(srcdir)/Tools/build/generate_build_details.py `cat pybuilddir.txt`/build-details.json

# Build static library
$(LIBRARY): $(LIBRARY_OBJS)
Expand Down
3 changes: 3 additions & 0 deletions Misc/NEWS.d/next/Core_and_Builtins/2025-09-04-00-32-28.gh-issue-138489.Adc9Lx.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
The :pep:`739` :file:`build-details.json` file is now generated and
installed on Windows.
Patch by Adam Turner.
10 changes: 10 additions & 0 deletions PC/layout/main.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@
__path__ = [str(Path(__file__).resolve().parent)]

from .support.appxmanifest import *
from .support.build_details import *
from .support.catalog import *
from .support.constants import *
from .support.filesets import *
Expand DownExpand Up@@ -319,6 +320,9 @@ def _c(d):
if ns.include_install_json or ns.include_install_embed_json or ns.include_install_test_json:
yield "__install__.json", ns.temp / "__install__.json"

if ns.include_build_details_json:
yield "build-details.json", ns.temp / "build-details.json"


def _compile_one_py(src, dest, name, optimize, checked=True):
import py_compile
Expand DownExpand Up@@ -426,6 +430,12 @@ def generate_source_files(ns):
with open(ns.temp / "__install__.json", "w", encoding="utf-8") as f:
json.dump(calculate_install_json(ns, for_test=True), f, indent=2)

if ns.include_build_details_json:
log_info("Generating build-details.json in {}", ns.temp)
ns.temp.mkdir(parents=True, exist_ok=True)
base_path = Path(sys.base_prefix, "build-details.json")
write_relative_build_details(ns.temp / "build-details.json", base_path)


def _create_zip_file(ns):
if not ns.zip:
Expand Down
37 changes: 37 additions & 0 deletions PC/layout/support/build_details.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
"""
Generate the PEP 739 'build-details.json' document.
"""

import sys
from pathlib import Path

PEP739_SCHEMA_VERSION = '1.0'

@zoobazoobaSep 16, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
PEP739_SCHEMA_VERSION='1.0'
__all__=["write_relative_build_details"]
PEP739_SCHEMA_VERSION='1.0'


ROOT_DIR = Path(
__file__, # PC/layout/support/build_details.py
'..', # PC/layout/support
'..', # PC/layout
'..', # PC
'..', # <src/install dir>
).resolve()
TOOLS_BUILD_DIR = ROOT_DIR / 'Tools' / 'build'

sys_path = sys.path[:]
try:
sys.path.insert(0, str(TOOLS_BUILD_DIR))
import generate_build_details
except ImportError:
generate_build_details = None
finally:
sys.path = sys_path
del sys_path
Comment on lines +10 to +27

@zoobazoobaSep 16, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm afraid this probably needs to replicate most of the functionality from that script and do trickier calculations. The repo containing the running PC/layout isn't necessarily the same as the commit used to build, and the running interpreter isn't necessarily the same as the one we just built.

So the details have to be calculated from the referenced source files (i.e. layout.support.constants and layout.support.arch), not from the current runtime at all.

That said, I haven't dug into the write_build_details function and maybe it does it, but it really doesn't look like enough information is being provided to make it viable (especially when you factor in that {base_path}\python.exe is not executable).

Comment on lines +10 to +27

@FFY00FFY00Oct 4, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we really need to import the script here instead of invoking it?

@zoobazoobaOct 6, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can't do either - we might need to generate the file without being able to launch the runtime. See my comment above on the same section of code.



def write_relative_build_details(out_path, base_path):
if generate_build_details is None:
return
generate_build_details.write_build_details(
schema_version=PEP739_SCHEMA_VERSION,
base_path=base_path,
location=out_path,
)
9 changes: 8 additions & 1 deletion PC/layout/support/options.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,7 @@ def public(f):
"install-json": {"help": "a PyManager __install__.json file"},
"install-embed-json": {"help": "a PyManager __install__.json file for embeddable distro"},
"install-test-json": {"help": "a PyManager __install__.json for the test distro"},
"build-details-json": {"help": "a PEP 739 build-details.json file"},
}


Expand All@@ -56,6 +57,7 @@ def public(f):
"appxmanifest",
"alias",
"alias3x",
"build-details-json",
# XXX: Disabled for now "precompile",
],
},
Expand All@@ -69,9 +71,10 @@ def public(f):
"props",
"nuspec",
"alias",
"build-details-json",
],
},
"iot": {"help": "Windows IoT Core", "options": ["alias", "stable", "pip"]},
"iot": {"help": "Windows IoT Core", "options": ["alias", "stable", "pip", "build-details-json"]},
"default": {
"help": "development kit package",
"options": [
Expand All@@ -85,6 +88,7 @@ def public(f):
"symbols",
"html-doc",
"alias",
"build-details-json",
],
},
"embed": {
Expand All@@ -96,6 +100,7 @@ def public(f):
"flat-dlls",
"underpth",
"precompile",
"build-details-json",

@zoobazoobaSep 16, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suspect the contents of the file needs to be different for the embeddable package (no Lib directory or Includes/libs, for example). Maybe just omit it for now

],
},
"pymanager": {
Expand All@@ -109,6 +114,7 @@ def public(f):
"dev",
"html-doc",
"install-json",
"build-details-json",
],
},
"pymanager-test": {
Expand All@@ -124,6 +130,7 @@ def public(f):
"symbols",
"tests",
"install-test-json",
"build-details-json",
],
},
}
Expand Down
6 changes: 6 additions & 0 deletions PCbuild/python.vcxproj
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -126,6 +126,12 @@
<Message Text="Generating $(OutDir)pybuilddir.txt" />
<WriteLinesToFile File="$(OutDir)pybuilddir.txt" Lines="%0D%0A" Overwrite="true" />
</Target>
<Target Name="GenerateBuildDetailsJSON" AfterTargets="Link">
<Message Text="Generating $(OutDir)build-details.json" />
<Exec Command='setlocal
set PYTHONPATH=$(PySourcePath)Lib
Comment on lines +131 to +132

@AA-TurnerAA-TurnerSep 4, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unsure if these bits are needed, I copied them from the entry slightly further down.

"$(OutDir)$(PyExeName)$(PyDebugExt).exe" "$(PySourcePath)Tools\build\generate_build_details.py" "$(OutDir)build-details.json"' ContinueOnError="true" />
</Target>
<Target Name="ValidateUcrtbase" AfterTargets="AfterBuild" Condition="$(Configuration) != 'PGInstrument' and $(Platform) != 'ARM' and $(Platform) != 'ARM64'">
<PropertyGroup>
<UcrtName>ucrtbase</UcrtName>
Expand Down
3 changes: 3 additions & 0 deletions PCbuild/pythoncore.vcxproj
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -735,4 +735,7 @@
<Target Name="_DeletePyBuildDirTxt" BeforeTargets="PrepareForBuild">
<Delete Files="$(OutDir)pybuilddir.txt" />
</Target>
<Target Name="_DeleteBuildDetailsJson" BeforeTargets="PrepareForBuild">
<Delete Files="$(OutDir)build-details.json" />
</Target>
</Project>
Loading
Loading