Files
Failed to load latest commit information.
PCbuild
Folders and files
Name | Name | Last commit date | ||
---|---|---|---|---|
parent directory.. | ||||
Quick Start Guide ----------------- 1. Install Microsoft Visual Studio 2017 or later with Python workload and Python native development component. 1a. Optionally install Python 3.10 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 Clang/LLVM -------------------------------- See https://learn.microsoft.com/cpp/build/clang-support-msbuild for how to install and use clang-cl bundled with Microsoft Visual Studio. You can use the IDE to switch to clang-cl for local development, but because this alters the *.vcxproj files, the recommended way is to use build.bat: build.bat "/p:PlatformToolset=ClangCL" All other build.bat options continue to work as with MSVC, so this will create a 64bit release binary. You can also use a specific version of clang-cl downloaded from 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 * _decimal * _elementtree * _hashlib * _multiprocessing * _overlapped * _queue * _remote_debugging * _socket * _testbuffer * _testcapi * _testclinic * _testclinic_limited * _testconsole * _testimportmultiple * _testinternalcapi * _testlimitedcapi * _testmultiphase * _testsinglephase * _uuid * _wmi * _zoneinfo * 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, which is itself built by liblzma.vcxproj. Homepage: https://tukaani.org/xz/ _ssl Python wrapper for version 3.0.15 of the OpenSSL secure sockets library, which is itself downloaded from our binaries repository at https://github.com/python/cpython-bin-deps and built by openssl.vcxproj. 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.49.1, which is itself built by sqlite3.vcxproj Homepage: https://www.sqlite.org/ _tkinter Wraps version 8.6.15 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 and build them via the tcl.vcxproj and tk.vcxproj sub-projects. 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. _zstd Python wrapper for version 1.5.7 of the zstd compression library Homepage: https://facebook.github.io/zstd/ zlib-ng Compiles zlib-ng as a static library, which is later included by pythoncore.vcxproj. This was generated using CMake against zlib-ng version 2.2.4, and should be minimally updated as needed to adapt to changes in their source layout. The zbuild.h, zconf.h and zconf-ng.h file in the PC directory were likewise generated and vendored. Sources for zlib-ng are imported unmodified into our source repository at https://github.com/python/cpython-source-deps. _zstd Python wrapper for version 1.5.7 of the Zstandard compression library Homepage: https://facebook.github.io/zstd/ 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. Everything downloaded by these scripts is stored in ..\externals (relative to this directory), or the path specified by the EXTERNALS_DIR environment variable. The path or command to use for Python can be provided with the PYTHON_FOR_BUILD environment variable. If this is not set, an active virtual environment will be used. If none is active, and HOST_PYTHON is set to a recent enough version or "py.exe" is able to find a recent enough version, those will be used. If all else fails, a copy of Python will be downloaded from NuGet and extracted to the externals directory. This will then be used for later builds (see PCbuild/find_python.bat for the full logic). 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