cpython/PCbuild
Guido van Rossum 7e135a48d6
gh-111520: Integrate the Tier 2 interpreter in the Tier 1 interpreter (#111428)
- There is no longer a separate Python/executor.c file.
- Conventions in Python/bytecodes.c are slightly different -- don't use `goto error`,
  you must use `GOTO_ERROR(error)` (same for others like `unused_local_error`).
- The `TIER_ONE` and `TIER_TWO` symbols are only valid in the generated (.c.h) files.
- In Lib/test/support/__init__.py, `Py_C_RECURSION_LIMIT` is imported from `_testcapi`.
- On Windows, in debug mode, stack allocation grows from 8MiB to 12MiB.
- **Beware!** This changes the env vars to enable uops and their debugging
  to `PYTHON_UOPS` and `PYTHON_LLTRACE`.
2023-11-01 13:13:02 -07:00
..
Directory.Build.props bpo-45931: Prevent Directory.Build.props/targets from leaking from directories above the repo when building on Windows (GH-29854) 2021-11-29 22:40:34 +00:00
Directory.Build.targets bpo-45931: Prevent Directory.Build.props/targets from leaking from directories above the repo when building on Windows (GH-29854) 2021-11-29 22:40:34 +00:00
_asyncio.vcxproj bpo-36941: Windows build changes for Windows ARM64 (GH-13365) 2019-05-17 10:07:24 -07:00
_asyncio.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
_bz2.vcxproj bpo-36941: Windows build changes for Windows ARM64 (GH-13365) 2019-05-17 10:07:24 -07:00
_bz2.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
_ctypes.vcxproj gh-100540: Remove obsolete Modules/_ctypes/darwin/ dlfcn shim (GH-100541) 2022-12-29 16:13:28 -06:00
_ctypes.vcxproj.filters gh-100540: Remove obsolete Modules/_ctypes/darwin/ dlfcn shim (GH-100541) 2022-12-29 16:13:28 -06:00
_ctypes_test.vcxproj bpo-36941: Windows build changes for Windows ARM64 (GH-13365) 2019-05-17 10:07:24 -07:00
_ctypes_test.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
_decimal.vcxproj MSVC: The ARM command line should not define MASM. (#21817) 2020-08-10 22:39:46 +02:00
_decimal.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
_elementtree.vcxproj bpo-45570: Simplify setup macros for pyexpat (GH-29159) 2021-10-22 09:28:23 -07:00
_elementtree.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
_freeze_module.vcxproj gh-111520: Integrate the Tier 2 interpreter in the Tier 1 interpreter (#111428) 2023-11-01 13:13:02 -07:00
_freeze_module.vcxproj.filters gh-111520: Integrate the Tier 2 interpreter in the Tier 1 interpreter (#111428) 2023-11-01 13:13:02 -07:00
_hashlib.vcxproj bpo-36941: Windows build changes for Windows ARM64 (GH-13365) 2019-05-17 10:07:24 -07:00
_hashlib.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
_lzma.vcxproj bpo-36941: Windows build changes for Windows ARM64 (GH-13365) 2019-05-17 10:07:24 -07:00
_lzma.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
_multiprocessing.vcxproj bpo-36941: Windows build changes for Windows ARM64 (GH-13365) 2019-05-17 10:07:24 -07:00
_multiprocessing.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
_overlapped.vcxproj bpo-36941: Windows build changes for Windows ARM64 (GH-13365) 2019-05-17 10:07:24 -07:00
_overlapped.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
_queue.vcxproj bpo-36941: Windows build changes for Windows ARM64 (GH-13365) 2019-05-17 10:07:24 -07:00
_queue.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
_socket.vcxproj gh-92658: Add Hyper-V socket support (GH-92755) 2022-05-24 21:37:06 +01:00
_socket.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
_sqlite3.vcxproj gh-95656: Enable the sqlite3 load extension API in Windows build (#95662) 2022-08-04 21:26:13 +02:00
_sqlite3.vcxproj.filters gh-69093: Support basic incremental I/O to blobs in `sqlite3` (GH-30680) 2022-04-14 17:02:56 -07:00
_ssl.vcxproj Ensure some build files include a newline at to avoid warnings (GH-100946) 2023-01-11 17:28:57 +00:00
_ssl.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
_testbuffer.vcxproj bpo-36941: Windows build changes for Windows ARM64 (GH-13365) 2019-05-17 10:07:24 -07:00
_testbuffer.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
_testcapi.vcxproj gh-111495: add stub files for C API test modules (GH-111586) 2023-11-01 07:44:54 +02:00
_testcapi.vcxproj.filters gh-111495: add stub files for C API test modules (GH-111586) 2023-11-01 07:44:54 +02:00
_testclinic.vcxproj gh-104629: Build _testclinic extension module on Windows (#104723) 2023-07-28 18:31:30 +02:00
_testclinic.vcxproj.filters gh-104629: Build _testclinic extension module on Windows (#104723) 2023-07-28 18:31:30 +02:00
_testclinic_limited.vcxproj gh-108494: Build _testclinic_limited on Windows (#108589) 2023-08-28 23:51:39 +00:00
_testclinic_limited.vcxproj.filters gh-108494: Build _testclinic_limited on Windows (#108589) 2023-08-28 23:51:39 +00:00
_testconsole.vcxproj bpo-36941: Windows build changes for Windows ARM64 (GH-13365) 2019-05-17 10:07:24 -07:00
_testconsole.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
_testembed.vcxproj bpo-36941: Windows build changes for Windows ARM64 (GH-13365) 2019-05-17 10:07:24 -07:00
_testembed.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
_testimportmultiple.vcxproj bpo-36941: Windows build changes for Windows ARM64 (GH-13365) 2019-05-17 10:07:24 -07:00
_testimportmultiple.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
_testinternalcapi.vcxproj gh-110525: Add tests for internal `set` CAPI (GH-110630) 2023-10-10 19:00:05 +03:00
_testinternalcapi.vcxproj.filters gh-108724: Add PyMutex and _PyParkingLot APIs (gh-109344) 2023-09-19 09:54:29 -06:00
_testmultiphase.vcxproj bpo-36941: Windows build changes for Windows ARM64 (GH-13365) 2019-05-17 10:07:24 -07:00
_testmultiphase.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
_testsinglephase.vcxproj gh-98627: Add the _testsinglephase Module (gh-99039) 2022-11-08 09:58:11 -07:00
_testsinglephase.vcxproj.filters gh-98627: Add the _testsinglephase Module (gh-99039) 2022-11-08 09:58:11 -07:00
_tkinter.vcxproj gh-99834: Update bundled copy of Tcl/Tk to 8.6.13.0 on Windows (GH-101307) 2023-01-26 20:47:24 +00:00
_tkinter.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
_uuid.vcxproj bpo-40501: Replace ctypes code in uuid with native module (GH-19948) 2020-05-12 23:32:32 +01:00
_uuid.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
_wmi.vcxproj gh-89545: Updates platform module to use new internal _wmi module on Windows to directly query OS properties (GH-96289) 2022-09-07 21:09:20 +01:00
_wmi.vcxproj.filters gh-89545: Updates platform module to use new internal _wmi module on Windows to directly query OS properties (GH-96289) 2022-09-07 21:09:20 +01:00
_zoneinfo.vcxproj bpo-40503: PEP 615: Tests and implementation for zoneinfo (GH-19909) 2020-05-16 10:20:06 +02:00
_zoneinfo.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
blurb.bat bpo-43915: Add PCbuild/blurb.bat to simplify Windows contributors (GH-25528) 2021-04-22 20:45:47 +01:00
build.bat gh-108374: Add --disable-gil option to PCbuild/build.bat (#108729) 2023-09-02 16:13:00 -05:00
build_env.bat bpo-27425: Be more explicit in .gitattributes (GH-840) 2017-06-10 14:58:42 -05:00
clean.bat bpo-31609: Fixes quotes in PCbuild/clean.bat (#4280) 2017-11-04 16:29:03 -07:00
env.bat bpo-42336: Improve PCbuild batch files (GH-23275) 2020-11-18 17:24:36 +00:00
env.ps1 bpo-42336: Improve PCbuild batch files (GH-23275) 2020-11-18 17:24:36 +00:00
field3.py
find_msbuild.bat bpo-39930: Fix MSBuild detection for Build Tools (GH-18938) 2020-03-11 16:24:30 -07:00
find_python.bat gh-107814: Avoid output from Nuget installation in find_python.bat (GH-107815) 2023-08-09 23:42:16 +01:00
fix_encoding.py Mark files as executable that are meant as scripts. (GH-15354) 2019-09-09 07:16:33 -07:00
get_external.py bpo-45055: Add retry when downloading externals on Windows (GH-28399) 2021-09-20 15:33:00 +01:00
get_externals.bat gh-109286: Update Windows installer to use SQLite 3.43.1 (#110403) 2023-10-06 17:12:15 +02:00
idle.bat bpo-42336: Improve PCbuild batch files (GH-23275) 2020-11-18 17:24:36 +00:00
libffi.props bpo-45022: Update libffi to 3.4.2 in Windows build (GH-28146) 2021-09-03 19:37:31 +01:00
liblzma.vcxproj bpo-40859: Update Windows build to use xz-5.2.5 (GH-20622) 2022-04-19 17:36:51 +01:00
liblzma.vcxproj.filters bpo-40859: Update Windows build to use xz-5.2.5 (GH-20622) 2022-04-19 17:36:51 +01:00
openssl.props gh-99079: Update Windows build to use OpenSSL 3.0.9 (GH-106649) 2023-07-12 13:46:30 +01:00
openssl.vcxproj bpo-35926: Add support for OpenSSL 1.1.1b on Windows (GH-11779) 2019-05-15 15:38:55 -07:00
pcbuild.proj gh-108494: Build _testclinic_limited on Windows (#108589) 2023-08-28 23:51:39 +00:00
pcbuild.sln gh-108494: Build _testclinic_limited on Windows (#108589) 2023-08-28 23:51:39 +00:00
prepare_libffi.bat LibFFI build requires x64 Cygwin, and skip the ARM build (GH-101743) 2023-02-09 17:15:19 +00:00
prepare_ssl.bat bpo-35926: Add support for OpenSSL 1.1.1b on Windows (GH-11779) 2019-05-15 15:38:55 -07:00
prepare_ssl.py Mark files as executable that are meant as scripts. (GH-15354) 2019-09-09 07:16:33 -07:00
prepare_tcltk.bat gh-75552: Remove deprecated tkinter.tix module (GH-104902) 2023-05-27 12:34:19 -05:00
pyexpat.vcxproj bpo-45570: Simplify setup macros for pyexpat (GH-29159) 2021-10-22 09:28:23 -07:00
pyexpat.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
pylauncher.vcxproj bpo-46566: Add new py.exe launcher implementation (GH-32062) 2022-03-29 00:21:08 +01:00
pylauncher.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
pyproject.props gh-90815: Add mimalloc memory allocator (#109914) 2023-10-30 15:43:11 +00:00
pyshellext.vcxproj bpo-41070: Simplify pyshellext.dll build (GH-21037) 2020-06-24 00:32:23 +01:00
pyshellext.vcxproj.filters bpo-41070: Simplify pyshellext.dll build (GH-21037) 2020-06-24 00:32:23 +01:00
python.props gh-109286: Update Windows installer to use SQLite 3.43.1 (#110403) 2023-10-06 17:12:15 +02:00
python.vcxproj gh-111520: Integrate the Tier 2 interpreter in the Tier 1 interpreter (#111428) 2023-11-01 13:13:02 -07:00
python.vcxproj.filters
python3dll.vcxproj bpo-41039: Simplify python3.dll build (GH-20989) 2020-06-23 20:33:23 +01:00
python3dll.vcxproj.filters bpo-41039: Simplify python3.dll build (GH-20989) 2020-06-23 20:33:23 +01:00
python_uwp.vcxproj bpo-40458: Increase reserved stack space to prevent overflow crash on Windows (GH-19845) 2020-05-05 18:45:35 +01:00
python_uwp.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
pythoncore.vcxproj gh-111520: Integrate the Tier 2 interpreter in the Tier 1 interpreter (#111428) 2023-11-01 13:13:02 -07:00
pythoncore.vcxproj.filters gh-111520: Integrate the Tier 2 interpreter in the Tier 1 interpreter (#111428) 2023-11-01 13:13:02 -07:00
pythonw.vcxproj Increase stack reserve size for Windows debug builds to avoid test crashes (GH-102764) 2023-03-17 01:07:07 +00:00
pythonw.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
pythonw_uwp.vcxproj bpo-40458: Increase reserved stack space to prevent overflow crash on Windows (GH-19845) 2020-05-05 18:45:35 +01:00
pythonw_uwp.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
pywlauncher.vcxproj bpo-46566: Add new py.exe launcher implementation (GH-32062) 2022-03-29 00:21:08 +01:00
pywlauncher.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
readme.txt gh-109286: Update Windows installer to use SQLite 3.43.1 (#110403) 2023-10-06 17:12:15 +02:00
regen.targets gh-105481: remove regen-opcode. Generated _PyOpcode_Caches in regen-cases. (#108367) 2023-08-23 18:39:00 +01:00
rmpyc.py bpo-29770: remove outdated PYO related info (GH-590) 2017-03-11 13:02:52 +08:00
rt.bat gh-109566: PCbuild/rt.bat now uses --fast-ci (#110120) 2023-09-29 19:16:29 +00:00
select.vcxproj bpo-36941: Windows build changes for Windows ARM64 (GH-13365) 2019-05-17 10:07:24 -07:00
select.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
sqlite3.vcxproj bpo-46907: Update Windows installer to SQLite 3.38.3. (GH-91995) 2022-05-02 16:02:54 +01:00
sqlite3.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
tcl.vcxproj bpo-46567: Add Tcl/Tk build for Windows ARM64 (GH-31574) 2022-02-28 12:06:43 +00:00
tcltk.props gh-75552: Remove deprecated tkinter.tix module (GH-104902) 2023-05-27 12:34:19 -05:00
tk.vcxproj bpo-46567: Add Tcl/Tk build for Windows ARM64 (GH-31574) 2022-02-28 12:06:43 +00:00
unicodedata.vcxproj bpo-36941: Windows build changes for Windows ARM64 (GH-13365) 2019-05-17 10:07:24 -07:00
unicodedata.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
urlretrieve.py bpo-30450: Adds alternate download approach for nuget.exe (#2737) 2017-07-17 14:55:28 +02:00
venvlauncher.vcxproj bpo-36941: Windows build changes for Windows ARM64 (GH-13365) 2019-05-17 10:07:24 -07:00
venvlauncher.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
venvwlauncher.vcxproj bpo-36941: Windows build changes for Windows ARM64 (GH-13365) 2019-05-17 10:07:24 -07:00
venvwlauncher.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
winsound.vcxproj bpo-36044: Avoid warnings in Windows PGO build and add lzma, bz2 and sqlite coverage (GH-14985) 2019-07-28 18:01:12 -07:00
winsound.vcxproj.filters bpo-41089: Filters and other issues in Visual Studio projects (GH-21070) 2020-06-23 19:41:49 +01:00
xxlimited.vcxproj bpo-41111: xxlimited.c defines Py_LIMITED_API (GH-25151) 2021-04-02 16:48:11 +02:00
xxlimited.vcxproj.filters
xxlimited_35.vcxproj bpo-41111: xxlimited.c defines Py_LIMITED_API (GH-25151) 2021-04-02 16:48:11 +02:00
xxlimited_35.vcxproj.filters bpo-42111: Make the xxlimited module an example of best extension module practices (GH-23226) 2020-12-08 08:36:53 -08:00

readme.txt

Quick Start Guide
-----------------

1.  Install Microsoft Visual Studio 2017 or later with Python workload and
    Python native development component.
1a. Optionally install Python 3.6 or later.  If not installed,
    get_externals.bat (via build.bat) will download and use Python via
    NuGet.
2.  Run "build.bat" to build Python in 32-bit Release configuration.
3.  (Optional, but recommended) Run the test suite with "rt.bat -q".


Building Python using Microsoft Visual C++
------------------------------------------

This directory is used to build CPython for Microsoft Windows on 32- and 64-
bit platforms.  Using this directory requires an installation of
Microsoft Visual Studio (MSVC) with the *Python workload* and
its optional *Python native development* component selected.

Building from the command line is recommended in order to obtain any
external dependencies. To build, simply run the "build.bat" script without
any arguments. After this succeeds, you can open the "pcbuild.sln"
solution in Visual Studio to continue development.

To build an installer package, refer to the README in the Tools/msi folder.

The solution currently supports two platforms.  The Win32 platform is
used to build standard x86-compatible 32-bit binaries, output into the
win32 sub-directory.  The x64 platform is used for building 64-bit AMD64
(aka x86_64 or EM64T) binaries, output into the amd64 sub-directory.
The Itanium (IA-64) platform is no longer supported.

Four configuration options are supported by the solution:
Debug
    Used to build Python with extra debugging capabilities, equivalent
    to using ./configure --with-pydebug on UNIX.  All binaries built
    using this configuration have "_d" added to their name:
    python310_d.dll, python_d.exe, parser_d.pyd, and so on.  Both the
    build and rt (run test) batch files in this directory accept a -d
    option for debug builds.  If you are building Python to help with
    development of CPython, you will most likely use this configuration.
PGInstrument, PGUpdate
    Used to build Python in Release configuration using PGO, which
    requires Premium Edition of Visual Studio.  See the "Profile
    Guided Optimization" section below for more information.  Build
    output from each of these configurations lands in its own
    sub-directory of this directory.  The official Python releases may
    be built using these configurations.
Release
    Used to build Python as it is meant to be used in production
    settings, though without PGO.


Building Python using the build.bat script
----------------------------------------------

In this directory you can find build.bat, a script designed to make
building Python on Windows simpler.  This script will use the env.bat
script to detect either Visual Studio 2017 or 2015, either of
which may be used to build Python. Currently Visual Studio 2017 is
officially supported.

By default, build.bat will build Python in Release configuration for
the 32-bit Win32 platform.  It accepts several arguments to change
this behavior, try `build.bat -h` to learn more.


C Runtime
---------

Visual Studio 2017 uses version 14.0 of the C runtime (vcruntime140).
The executables no longer use the "Side by Side" assemblies used in
previous versions of the compiler.  This simplifies distribution of
applications.

The run time libraries are available under the redist folder of your
Visual Studio distribution. For more info, see the Readme in the
redist folder.


Sub-Projects
------------

The CPython project is split up into several smaller sub-projects which
are managed by the pcbuild.sln solution file.  Each sub-project is
represented by a .vcxproj and a .vcxproj.filters file starting with the
name of the sub-project.  These sub-projects fall into a few general
categories:

The following sub-projects represent the bare minimum required to build
a functioning CPython interpreter.  If nothing else builds but these,
you'll have a very limited but usable python.exe:
pythoncore
    .dll and .lib
python
    .exe

These sub-projects provide extra executables that are useful for running
CPython in different ways:
pythonw
    pythonw.exe, a variant of python.exe that doesn't open a Command
    Prompt window
pylauncher
    py.exe, the Python Launcher for Windows, see
        https://docs.python.org/3/using/windows.html#launcher
pywlauncher
    pyw.exe, a variant of py.exe that doesn't open a Command Prompt
    window
_testembed
    _testembed.exe, a small program that embeds Python for testing
    purposes, used by test_capi.py

These are miscellaneous sub-projects that don't really fit the other
categories:
_freeze_module
    _freeze_module.exe, used to regenerate frozen modules in Python
    after changes have been made to the corresponding source files
    (e.g. Lib\importlib\_bootstrap.py).
pyshellext
    pyshellext.dll, the shell extension deployed with the launcher
python3dll
    python3.dll, the PEP 384 Stable ABI dll
xxlimited
    builds an example module that makes use of the PEP 384 Stable ABI,
    see Modules\xxlimited.c
xxlimited_35
    ditto for testing the Python 3.5 stable ABI, see
    Modules\xxlimited_35.c

The following sub-projects are for individual modules of the standard
library which are implemented in C; each one builds a DLL (renamed to
.pyd) of the same name as the project:
_asyncio
_ctypes
_ctypes_test
_zoneinfo
_decimal
_elementtree
_hashlib
_multiprocessing
_overlapped
_socket
_testbuffer
_testcapi
_testclinic
_testclinic_limited
_testconsole
_testimportmultiple
_testmultiphase
_testsinglephase
_tkinter
pyexpat
select
unicodedata
winsound

The following Python-controlled sub-projects wrap external projects.
Note that these external libraries are not necessary for a working
interpreter, but they do implement several major features.  See the
"Getting External Sources" section below for additional information
about getting the source for building these libraries.  The sub-projects
are:
_bz2
    Python wrapper for version 1.0.8 of the libbzip2 compression library
    Homepage:
        http://www.bzip.org/
_lzma
    Python wrapper for version 5.2.2 of the liblzma compression library
    Homepage:
        https://tukaani.org/xz/
_ssl
    Python wrapper for version 3.0 of the OpenSSL secure sockets
    library, which is downloaded from our binaries repository at
    https://github.com/python/cpython-bin-deps.

    Homepage:
        https://www.openssl.org/

    Building OpenSSL requires Perl on your path, and can be performed by
    running PCbuild\prepare_ssl.bat. This will retrieve the version of
    the sources matched to the current commit from the OpenSSL branch
    in our source repository at
    https://github.com/python/cpython-source-deps.

    To use an alternative build of OpenSSL completely, you should replace
    the files in the externals/openssl-bin-<version> folder with your own.
    As long as this folder exists, its contents will not be downloaded
    again when building.

_sqlite3
    Wraps SQLite 3.43.1, which is itself built by sqlite3.vcxproj
    Homepage:
        https://www.sqlite.org/
_tkinter
    Wraps version 8.6.6 of the Tk windowing system, which is downloaded
    from our binaries repository at
    https://github.com/python/cpython-bin-deps.

    Homepage:
        https://www.tcl.tk/

    Building Tcl and Tk can be performed by running
    PCbuild\prepare_tcltk.bat. This will retrieve the version of the
    sources matched to the current commit from the Tcl and Tk branches
    in our source repository at
    https://github.com/python/cpython-source-deps.

    The two projects install their respective components in a
    directory alongside the source directories called "tcltk" on
    Win32 and "tcltk64" on x64.  They also copy the Tcl and Tk DLLs
    into the current output directory, which should ensure that Tkinter
    is able to load Tcl/Tk without having to change your PATH.


Getting External Sources
------------------------

The last category of sub-projects listed above wrap external projects
Python doesn't control, and as such a little more work is required in
order to download the relevant source files for each project before they
can be built.  However, a simple script is provided to make this as
painless as possible, called "get_externals.bat" and located in this
directory.  This script extracts all the external sub-projects from
    https://github.com/python/cpython-source-deps
and
    https://github.com/python/cpython-bin-deps
via a Python script called "get_external.py", located in this directory.
If Python 3.6 or later is not available via the "py.exe" launcher, the
path or command to use for Python can be provided in the PYTHON_FOR_BUILD
environment variable, or get_externals.bat will download the latest
version of NuGet and use it to download the latest "pythonx86" package
for use with get_external.py.  Everything downloaded by these scripts is
stored in ..\externals (relative to this directory).

It is also possible to download sources from each project's homepage,
though you may have to change folder names or pass the names to MSBuild
as the values of certain properties in order for the build solution to
find them.  This is an advanced topic and not necessarily fully
supported.

The get_externals.bat script is called automatically by build.bat
unless you pass the '-E' option.


Profile Guided Optimization
---------------------------

The solution has two configurations for PGO. The PGInstrument
configuration must be built first. The PGInstrument binaries are linked
against a profiling library and contain extra debug information. The
PGUpdate configuration takes the profiling data and generates optimized
binaries.

The build.bat script has an argument `--pgo` that automate the creation
of optimized binaries.
It creates the PGI files, runs the unit test suite with the PGI python,
and finally creates the optimized files.
You can customize the job for profiling with `--pgo-job <job>` option.

See
    https://docs.microsoft.com/en-us/cpp/build/profile-guided-optimizations
for more on this topic.


Static library
--------------

The solution has no configuration for static libraries. However it is
easy to build a static library instead of a DLL. You simply have to set
the "Configuration Type" to "Static Library (.lib)" and alter the
preprocessor macro "Py_ENABLE_SHARED" to "Py_NO_ENABLE_SHARED". You may
also have to change the "Runtime Library" from "Multi-threaded DLL
(/MD)" to "Multi-threaded (/MT)".


Visual Studio properties
------------------------

The PCbuild solution makes use of Visual Studio property files (*.props)
to simplify each project. The properties can be viewed in the Property
Manager (View -> Other Windows -> Property Manager) but should be
carefully modified by hand.

The property files used are:
 * python (versions, directories and build names)
 * pyproject (base settings for all projects)
 * openssl (used by projects dependent upon OpenSSL)
 * tcltk (used by _tkinter, tcl, and tk projects)

The pyproject property file defines all of the build settings for each
project, with some projects overriding certain specific values. The GUI
doesn't always reflect the correct settings and may confuse the user
with false information, especially for settings that automatically adapt
for different configurations.

Add a new project
-----------------

For example, add a new _testclinic_limited project to build a new
_testclinic_limited extension, the file Modules/_testclinic_limited.c:

* In PCbuild/, copy _testclinic.vcxproj to _testclinic_limited.vcxproj,
  replace RootNamespace value with `_testclinic_limited`, replace
  `_asyncio.c` with `_testclinic_limited.c`.
* Open Visual Studio, open PCbuild\pcbuild.sln solution, add the
  PCbuild\_testclinic_limited.vcxproj project to the solution ("add existing
  project).
* Add a dependency on the python project to the new _testclinic_limited
  project.
* Save and exit Visual Studio.
* Add `;_testclinic_limited` to `<TestModules Include="...">` in
  PCbuild\pcbuild.proj.
* Update "exts" in Tools\msi\lib\lib_files.wxs file or in
  Tools\msi\test\test_files.wxs file (for tests).
* PC\layout\main.py needs updating if you add a test-only extension whose name
  doesn't start with "_test".
* Add the extension to PCbuild\readme.txt (this file).
* Build Python from scratch (clean the solution) to check that the new project
  is built successfully.
* Ensure the new .vcxproj and .vcxproj.filters files are added to your commit,
  as well as the changes to pcbuild.sln, pcbuild.proj and any other modified
  files.