python-build-standalone/docs · py/python-build-standalone

GGitHubUse patch files for Windows source changes (#1388)

文件	最后提交记录	最后更新时间
stylesheets	convert docs to markdown, build using mkdocs and add action to publish to astral-sh/docs (#1234) Covert the project documentation to markdown from restructured text. Build the project documentation using mkdocs. The existing Sphinx based process is retained until the new docs are confirmed working and in place. Add a new action to build and publish documentation to astral-sh/docs. This action was based largely off the action from ruff. --------- Co-authored-by: Ee Durbin <ewdurbin@gmail.com>	1 个月前
Makefile	docs: split up README into Sphinx docs It was getting a bit long.	6 年前
building.md	Use patch files for Windows source changes (#1388) Windows builds encode fixed CPython and OpenSSL changes as inline replacements, and the xz fallback can leave a partially modified project when a later replacement fails. Move these edits into version-selected patches applied with `git apply`, normalizing line endings for CRLF project files and failing the build when a patch no longer applies. Build-specific paths and versions remain generated in Python. Remove the obsolete `_sqlite3.vcxproj` and `_freeze_importlib` rewrites for the supported CPython versions. Co-authored-by: zaniebot <242828183+zaniebot@users.noreply.github.com>	12 天前
building.rst	Add debug support for MSVC builds - full change PR (#1262) This PR is a full implementation of debug support for Windows build (addresses #26 in full) and combines three commits together only for the purposes of review. Should maintainers have a preference to proceed with it, happy to assist, but otherwise I will be raising a set of three separate PRs for each commit to be discussed and merged. 1. Add a debug build option for Windows (`cpython-windows/build.py`, `docs/building.rst`) - `debug` is added to the option set beside `noopt` and `pgo`, with the same ordering as Unix build already uses. Same as with Unix, this removes illegal combinations like `debug+pgo`. The set is renamed from `optimizations` to `options` also inline with the Unix build. - `configuration="Debug"` is passed to msbuild and `artifact_config` accordingly. `PC/layout` gets `--debug` and that drives the `_d` artifact suffixes. - executables, extension modules and dependency libraries pick up the `_d` suffix `$(PyDebugExt)` produces - the tail-calling interpreter is not enabled for Debug (first finding below, comments embedded in the patch) - `docs/building.rst` updated with the debug option and the debug CRT requirement 2. Accept a Windows debug distribution in the validator and disttests (`src/validation.rs`, `pythonbuild/disttests/__init__.py`) - the PE allow list gains the debug CRT (`ucrtbased.dll`, `VCRUNTIME140D.dll`, `VCRUNTIME140_1D.dll`), the `_d` interpreter DLLs and `sqlite3_d.dll` - the `abiflags` check consults `EXT_SUFFIX` on Windows (comments as to why are embedded inn the patch) - `test_ssl_with_keylogfile` is skipped on Windows debug builds following CPython's suite skipping keylog there 3. Build the Windows debug configurations in CI (`ci-targets.yaml`) - each Windows target has `pgo` and `freethreaded+pgo`; each gains `debug` and `freethreaded+debug` ## Evidence Every configuration added in the third patch was built, validated and tested: 26 jobs, VS 2022 everywhere except x64 3.15 on VS 2026, arm64 on `windows-11-arm` through `vcvarsamd64_arm64.bat` (I see #1261 raised and I will try my testbed on it too as it may be relevant for my changes). `debug` for 3.10 to 3.15 on x64, x86 and (from 3.11) arm64; `freethreaded+debug` for 3.13 to 3.15 on all three. All green: https://github.com/vadikmironov/omniglot-bazel-starter/actions/runs/34095975591 Each job ran exactly what `windows.yml` runs: `validate-distribution` and then `test-distribution.py` through the distribution's own interpreter (22 tests, 12 skipped, OK on every job). The archives carry `python314_d.dll` and `libs/python314_d.lib`, `python_d.exe` next to the canonical `python.exe` copy the existing code makes, `_d.cp314-win_amd64.pyd` as `EXT_SUFFIX`, and `Py_DEBUG=1` in the config vars; the free-threaded variant adds the `t` as expected. An embedder compiled `/MDd` against each links with only a `/LIBPATH`, and `sys.gettotalrefcount()` works at runtime. ## Four gotchas that are commented in the patches The tail-calling interpreter cannot be built in Debug. A guaranteed tail call needs optimisations which are removed by `/Od`. Microsoft documents `[[msvc::musttail]]` as requiring `/O2` (https://learn.microsoft.com/en-us/cpp/cpp/attributes#msvcmusttail), and CPython's gh-148047 shows the same flood of errors for `build.bat -c debug --tail-call-interp`. It is off for Debug. `Py_DEBUG` and `ABIFLAGS` reach Windows config vars only from 3.14. 3.13's `_sysconfig.config_vars()` supplies `EXT_SUFFIX`, `SOABI` and `Py_GIL_DISABLED`; 3.14 adds `Py_DEBUG` and emulates `ABIFLAGS` while keeping lowercase `abiflags` empty on Windows (https://github.com/python/cpython/blob/v3.14.7/Lib/sysconfig/__init__.py#L407). Validator reads `EXT_SUFFIX` instead. From 3.14 a free-threaded Windows install no longer declares itself. 3.14 ships a static `PC/pyconfig.h` that only normalises an externally supplied `Py_GIL_DISABLED`, so an embedder that does not pass `/DPy_GIL_DISABLED=1` gets a `#pragma comment(lib, ...)` naming the non-free-threaded import library. No changes per se and it applies to existing free-threaded builds already, but I will investigate the right course of actions separately. `SSLContext.keylog_filename` is unsupported on Windows debug builds. CPython's suite skips every keylog test there (https://github.com/python/cpython/blob/v3.11.16/Lib/test/test_ssl.py#L4827), and from 3.12 the call raises `NotImplementedError` under `_DEBUG` (https://github.com/python/cpython/blob/v3.12.14/Modules/_ssl/debughelpers.c#L168, from python/cpython#131839). `test_ssl_with_keylogfile` is skipped on every Windows debug build same CPython. ## Limitations - a debug distribution needs the debug CRT: `ucrtbased.dll` and `vcruntime140d.dll` are not redistributable by Microsoft. It only runs where Visual Studio is installed and it's exactly the same for CPython's debug binarie. - 3.10 has no arm64 configuration, following what `ci-targets.yaml` lists for that version - release-ABI wheels install into a debug interpreter but do not load, since Windows extension suffixes are `_d`-prefixed; CPython behaviour - `crt_features` stays `vcruntime:140`, though the debug binaries link the non-redistributable runtime. This is another open point and happy to tweak it further. ## CI Once the third commit is merged, it will add 26 jobs to every push to main, 15 to 26 minutes each on free runners. Again, happy to drop or amend it if that is too much.	1 个月前
conf.py	docs: split up README into Sphinx docs It was getting a bit long.	6 年前
distributions.md	convert docs to markdown, build using mkdocs and add action to publish to astral-sh/docs (#1234) Covert the project documentation to markdown from restructured text. Build the project documentation using mkdocs. The existing Sphinx based process is retained until the new docs are confirmed working and in place. Add a new action to build and publish documentation to astral-sh/docs. This action was based largely off the action from ruff. --------- Co-authored-by: Ee Durbin <ewdurbin@gmail.com>	1 个月前
distributions.rst	Update docs to reflect current state of project (#1229) Refresh the documentation to reflect the current state of the project and correct inaccuracies. * Explain how uv uses the project. * Update supported platforms, architectures, and Windows requirements. * Document free-threaded builds and available archive variants. * Clarify dynamic and static musl builds and their limitations. * Update build instructions, toolchains, and Visual Studio requirements. * Refresh technical notes on extension modules and bundled dependencies. * Remove obsolete platform claims, build targets, and project references. * Move information on PyOxidizer and PyOxy to the end of the running section.	2 个月前
index.md	Refresh README and docs introduction (#1298) Convert README to markdown with sections similar to other Astral projects. Reuse this as the introduction and update the docs URL to docs.astral.sh.	1 个月前
index.rst	Update docs to reflect current state of project (#1229) Refresh the documentation to reflect the current state of the project and correct inaccuracies. * Explain how uv uses the project. * Update supported platforms, architectures, and Windows requirements. * Document free-threaded builds and available archive variants. * Clarify dynamic and static musl builds and their limitations. * Update build instructions, toolchains, and Visual Studio requirements. * Refresh technical notes on extension modules and bundled dependencies. * Remove obsolete platform claims, build targets, and project references. * Move information on PyOxidizer and PyOxy to the end of the running section.	2 个月前
quirks.md	convert docs to markdown, build using mkdocs and add action to publish to astral-sh/docs (#1234) Covert the project documentation to markdown from restructured text. Build the project documentation using mkdocs. The existing Sphinx based process is retained until the new docs are confirmed working and in place. Add a new action to build and publish documentation to astral-sh/docs. This action was based largely off the action from ruff. --------- Co-authored-by: Ee Durbin <ewdurbin@gmail.com>	1 个月前
quirks.rst	Drop support for EOL Python 3.9 (#845) First pass for https://github.com/astral-sh/python-build-standalone/issues/841. There's some `3.9` still left in https://github.com/hugovk/python-build-standalone/blob/main/cpython-unix/targets.yml because seven targets _only_ support 3.9, like `aarch64-apple-ios` and `arm64-apple-tvos`: https://github.com/hugovk/python-build-standalone/blob/2181bddcc918f14275232ad6d1365035f2ae75c4/cpython-unix/targets.yml#L114-L119 Should they be removed? Or upgraded? Also ran `ruff check --select UP --target-version py310 --fix` and `run check --fix`. There's a lot of `--unsafe-fixes` that can be applied, but they can be in their own PR to avoid making this too big.	11 个月前
running.md	Publish Windows debug distributions (#1287) #1262 made windows debug builds work, but the release table was not part of it (which turned out to be just as well given #1283!). The change matches `ci-targets.yaml` exactly and publishes `-full` archives only. Debug archives are slightly smaller than PGO with ~40mb each they add ~1GB per release on top of ~55GB. Not sure how important this is, but after first release `uv python install 3.13+debug` will start resolving on Windows with the dependency on MSVC. It would only run where Visual Studio is installed. Let me know if I need to do something about it in uv or otherwise.	1 个月前
running.rst	Update docs to reflect current state of project (#1229) Refresh the documentation to reflect the current state of the project and correct inaccuracies. * Explain how uv uses the project. * Update supported platforms, architectures, and Windows requirements. * Document free-threaded builds and available archive variants. * Clarify dynamic and static musl builds and their limitations. * Update build instructions, toolchains, and Visual Studio requirements. * Refresh technical notes on extension modules and bundled dependencies. * Remove obsolete platform claims, build targets, and project references. * Move information on PyOxidizer and PyOxy to the end of the running section.	2 个月前
status.md	convert docs to markdown, build using mkdocs and add action to publish to astral-sh/docs (#1234) Covert the project documentation to markdown from restructured text. Build the project documentation using mkdocs. The existing Sphinx based process is retained until the new docs are confirmed working and in place. Add a new action to build and publish documentation to astral-sh/docs. This action was based largely off the action from ruff. --------- Co-authored-by: Ee Durbin <ewdurbin@gmail.com>	1 个月前
status.rst	Update docs to reflect current state of project (#1229) Refresh the documentation to reflect the current state of the project and correct inaccuracies. * Explain how uv uses the project. * Update supported platforms, architectures, and Windows requirements. * Document free-threaded builds and available archive variants. * Clarify dynamic and static musl builds and their limitations. * Update build instructions, toolchains, and Visual Studio requirements. * Refresh technical notes on extension modules and bundled dependencies. * Remove obsolete platform claims, build targets, and project references. * Move information on PyOxidizer and PyOxy to the end of the running section.	2 个月前
technotes.md	convert docs to markdown, build using mkdocs and add action to publish to astral-sh/docs (#1234) Covert the project documentation to markdown from restructured text. Build the project documentation using mkdocs. The existing Sphinx based process is retained until the new docs are confirmed working and in place. Add a new action to build and publish documentation to astral-sh/docs. This action was based largely off the action from ruff. --------- Co-authored-by: Ee Durbin <ewdurbin@gmail.com>	1 个月前
technotes.rst	Update docs to reflect current state of project (#1229) Refresh the documentation to reflect the current state of the project and correct inaccuracies. * Explain how uv uses the project. * Update supported platforms, architectures, and Windows requirements. * Document free-threaded builds and available archive variants. * Clarify dynamic and static musl builds and their limitations. * Update build instructions, toolchains, and Visual Studio requirements. * Refresh technical notes on extension modules and bundled dependencies. * Remove obsolete platform claims, build targets, and project references. * Move information on PyOxidizer and PyOxy to the end of the running section.	2 个月前