import argparse import os import platform import re import shutil import struct import subprocess import sys def cmd_cd(path): return f"cd /D {path}" def cmd_set(name, value): return f"set {name}={value}" def cmd_append(name, value): op = "path " if name == "PATH" else f"set {name}=" return op + f"%{name}%;{value}" def cmd_copy(src, tgt): return f'copy /Y /B "{src}" "{tgt}"' def cmd_xcopy(src, tgt): return f'xcopy /Y /E "{src}" "{tgt}"' def cmd_mkdir(path): return f'mkdir "{path}"' def cmd_rmdir(path): return f'rmdir /S /Q "{path}"' def cmd_nmake(makefile=None, target="", params=None): if params is None: params = "" elif isinstance(params, (list, tuple)): params = " ".join(params) else: params = str(params) return " ".join( [ "{nmake}", "-nologo", f'-f "{makefile}"' if makefile is not None else "", f"{params}", f'"{target}"', ] ) def cmds_cmake(target, *params): if not isinstance(target, str): target = " ".join(target) return [ " ".join( [ "{cmake}", "-DCMAKE_BUILD_TYPE=Release", "-DCMAKE_VERBOSE_MAKEFILE=ON", "-DCMAKE_RULE_MESSAGES:BOOL=OFF", # for NMake "-DCMAKE_C_COMPILER=cl.exe", # for Ninja "-DCMAKE_CXX_COMPILER=cl.exe", # for Ninja "-DCMAKE_C_FLAGS=-nologo", "-DCMAKE_CXX_FLAGS=-nologo", *params, '-G "{cmake_generator}"', ".", ] ), f"{{cmake}} --build . --clean-first --parallel --target {target}", ] def cmd_msbuild( file, configuration="Release", target="Build", platform="{msbuild_arch}" ): return " ".join( [ "{msbuild}", f"{file}", f'/t:"{target}"', f'/p:Configuration="{configuration}"', f"/p:Platform={platform}", "/m", ] ) SF_PROJECTS = "https://sourceforge.net/projects" architectures = { "x86": {"vcvars_arch": "x86", "msbuild_arch": "Win32"}, "x64": {"vcvars_arch": "x86_amd64", "msbuild_arch": "x64"}, "ARM64": {"vcvars_arch": "x86_arm64", "msbuild_arch": "ARM64"}, } header = [ cmd_set("INCLUDE", "{inc_dir}"), cmd_set("INCLIB", "{lib_dir}"), cmd_set("LIB", "{lib_dir}"), cmd_append("PATH", "{bin_dir}"), ] # dependencies, listed in order of compilation deps = { "libjpeg": { "url": SF_PROJECTS + "/libjpeg-turbo/files/2.1.5.1/libjpeg-turbo-2.1.5.1.tar.gz/download", "filename": "libjpeg-turbo-2.1.5.1.tar.gz", "dir": "libjpeg-turbo-2.1.5.1", "license": ["README.ijg", "LICENSE.md"], "license_pattern": ( "(LEGAL ISSUES\n============\n\n.+?)\n\nREFERENCES\n==========" ".+(libjpeg-turbo Licenses\n======================\n\n.+)$" ), "build": [ *cmds_cmake( ("jpeg-static", "cjpeg-static", "djpeg-static"), "-DENABLE_SHARED:BOOL=FALSE", "-DWITH_JPEG8:BOOL=TRUE", "-DWITH_CRT_DLL:BOOL=TRUE", ), cmd_copy("jpeg-static.lib", "libjpeg.lib"), cmd_copy("cjpeg-static.exe", "cjpeg.exe"), cmd_copy("djpeg-static.exe", "djpeg.exe"), ], "headers": ["j*.h"], "libs": ["libjpeg.lib"], "bins": ["cjpeg.exe", "djpeg.exe"], }, "zlib": { "url": "https://zlib.net/zlib1213.zip", "filename": "zlib1213.zip", "dir": "zlib-1.2.13", "license": "README", "license_pattern": "Copyright notice:\n\n(.+)$", "build": [ cmd_nmake(r"win32\Makefile.msc", "clean"), cmd_nmake(r"win32\Makefile.msc", "zlib.lib"), cmd_copy("zlib.lib", "z.lib"), ], "headers": [r"z*.h"], "libs": [r"*.lib"], }, "xz": { "url": SF_PROJECTS + "/lzmautils/files/xz-5.4.3.tar.gz/download", "filename": "xz-5.4.3.tar.gz", "dir": "xz-5.4.3", "license": "COPYING", "build": [ *cmds_cmake("liblzma", "-DBUILD_SHARED_LIBS:BOOL=OFF"), cmd_mkdir(r"{inc_dir}\lzma"), cmd_copy(r"src\liblzma\api\lzma\*.h", r"{inc_dir}\lzma"), ], "headers": [r"src\liblzma\api\lzma.h"], "libs": [r"liblzma.lib"], }, "libwebp": { "url": "http://downloads.webmproject.org/releases/webp/libwebp-1.3.0.tar.gz", "filename": "libwebp-1.3.0.tar.gz", "dir": "libwebp-1.3.0", "license": "COPYING", "build": [ cmd_rmdir(r"output\release-static"), # clean cmd_nmake( "Makefile.vc", "all", [ "CFG=release-static", "RTLIBCFG=dynamic", "OBJDIR=output", "ARCH={architecture}", "LIBWEBP_BASENAME=webp", ], ), cmd_mkdir(r"{inc_dir}\webp"), cmd_copy(r"src\webp\*.h", r"{inc_dir}\webp"), ], "libs": [r"output\release-static\{architecture}\lib\*.lib"], }, "libtiff": { "url": "https://download.osgeo.org/libtiff/tiff-4.5.0.tar.gz", "filename": "tiff-4.5.0.tar.gz", "dir": "tiff-4.5.0", "license": "LICENSE.md", "patch": { r"libtiff\tif_lzma.c": { # link against liblzma.lib "#ifdef LZMA_SUPPORT": '#ifdef LZMA_SUPPORT\n#pragma comment(lib, "liblzma.lib")', # noqa: E501 }, r"libtiff\tif_webp.c": { # link against webp.lib "#ifdef WEBP_SUPPORT": '#ifdef WEBP_SUPPORT\n#pragma comment(lib, "webp.lib")', # noqa: E501 }, }, "build": [ *cmds_cmake( "tiff", "-DBUILD_SHARED_LIBS:BOOL=OFF", '-DCMAKE_C_FLAGS="-nologo -DLZMA_API_STATIC"', ) ], "headers": [r"libtiff\tiff*.h"], "libs": [r"libtiff\*.lib"], # "bins": [r"libtiff\*.dll"], }, "libpng": { "url": SF_PROJECTS + "/libpng/files/libpng16/1.6.39/lpng1639.zip/download", "filename": "lpng1639.zip", "dir": "lpng1639", "license": "LICENSE", "build": [ *cmds_cmake("png_static", "-DPNG_SHARED:BOOL=OFF", "-DPNG_TESTS:BOOL=OFF"), cmd_copy("libpng16_static.lib", "libpng16.lib"), ], "headers": [r"png*.h"], "libs": [r"libpng16.lib"], }, "brotli": { "url": "https://github.com/google/brotli/archive/refs/tags/v1.0.9.tar.gz", "filename": "brotli-1.0.9.tar.gz", "dir": "brotli-1.0.9", "license": "LICENSE", "build": [ *cmds_cmake(("brotlicommon-static", "brotlidec-static")), cmd_xcopy(r"c\include", "{inc_dir}"), ], "libs": ["*.lib"], }, "freetype": { "url": "https://download.savannah.gnu.org/releases/freetype/freetype-2.13.0.tar.gz", # noqa: E501 "filename": "freetype-2.13.0.tar.gz", "dir": "freetype-2.13.0", "license": ["LICENSE.TXT", r"docs\FTL.TXT", r"docs\GPLv2.TXT"], "patch": { r"builds\windows\vc2010\freetype.vcxproj": { # freetype setting is /MD for .dll and /MT for .lib, we need /MD "MultiThreaded": "MultiThreadedDLL", # noqa: E501 # freetype doesn't specify SDK version, MSBuild may guess incorrectly '': '\n $(WindowsSDKVersion)', # noqa: E501 }, r"builds\windows\vc2010\freetype.user.props": { "": "FT_CONFIG_OPTION_SYSTEM_ZLIB;FT_CONFIG_OPTION_USE_PNG;FT_CONFIG_OPTION_USE_HARFBUZZ;FT_CONFIG_OPTION_USE_BROTLI", # noqa: E501 "": r"{dir_harfbuzz}\src;{inc_dir}", # noqa: E501 "": "{lib_dir}", # noqa: E501 "": "zlib.lib;libpng16.lib;brotlicommon-static.lib;brotlidec-static.lib", # noqa: E501 }, r"src/autofit/afshaper.c": { # link against harfbuzz.lib "#ifdef FT_CONFIG_OPTION_USE_HARFBUZZ": '#ifdef FT_CONFIG_OPTION_USE_HARFBUZZ\n#pragma comment(lib, "harfbuzz.lib")', # noqa: E501 }, }, "build": [ cmd_rmdir("objs"), cmd_msbuild( r"builds\windows\vc2010\freetype.sln", "Release Static", "Clean" ), cmd_msbuild( r"builds\windows\vc2010\freetype.sln", "Release Static", "Build" ), cmd_xcopy("include", "{inc_dir}"), ], "libs": [r"objs\{msbuild_arch}\Release Static\freetype.lib"], # "bins": [r"objs\{msbuild_arch}\Release\freetype.dll"], }, "lcms2": { "url": SF_PROJECTS + "/lcms/files/lcms/2.15/lcms2-2.15.tar.gz/download", "filename": "lcms2-2.15.tar.gz", "dir": "lcms2-2.15", "license": "COPYING", "patch": { r"Projects\VC2022\lcms2_static\lcms2_static.vcxproj": { # default is /MD for x86 and /MT for x64, we need /MD always "MultiThreaded": "MultiThreadedDLL", # noqa: E501 # retarget to default toolset (selected by vcvarsall.bat) "v143": "$(DefaultPlatformToolset)", # noqa: E501 # retarget to latest (selected by vcvarsall.bat) "10.0": "$(WindowsSDKVersion)", # noqa: E501 } }, "build": [ cmd_rmdir("Lib"), cmd_rmdir(r"Projects\VC2022\Release"), cmd_msbuild(r"Projects\VC2022\lcms2.sln", "Release", "Clean"), cmd_msbuild( r"Projects\VC2022\lcms2.sln", "Release", "lcms2_static:Rebuild" ), cmd_xcopy("include", "{inc_dir}"), ], "libs": [r"Lib\MS\*.lib"], }, "openjpeg": { "url": "https://github.com/uclouvain/openjpeg/archive/v2.5.0.tar.gz", "filename": "openjpeg-2.5.0.tar.gz", "dir": "openjpeg-2.5.0", "license": "LICENSE", "patch": { r"src\lib\openjp2\ht_dec.c": { "#ifdef OPJ_COMPILER_MSVC\n return (OPJ_UINT32)__popcnt(val);": "#if defined(OPJ_COMPILER_MSVC) && (defined(_M_IX86) || defined(_M_AMD64))\n return (OPJ_UINT32)__popcnt(val);", # noqa: E501 } }, "build": [ *cmds_cmake( "openjp2", "-DBUILD_CODEC:BOOL=OFF", "-DBUILD_SHARED_LIBS:BOOL=OFF" ), cmd_mkdir(r"{inc_dir}\openjpeg-2.5.0"), cmd_copy(r"src\lib\openjp2\*.h", r"{inc_dir}\openjpeg-2.5.0"), ], "libs": [r"bin\*.lib"], }, "libimagequant": { # commit: Merge branch 'master' into msvc (matches 2.17.0 tag) "url": "https://github.com/ImageOptim/libimagequant/archive/e4c1334be0eff290af5e2b4155057c2953a313ab.zip", # noqa: E501 "filename": "libimagequant-e4c1334be0eff290af5e2b4155057c2953a313ab.zip", "dir": "libimagequant-e4c1334be0eff290af5e2b4155057c2953a313ab", "license": "COPYRIGHT", "patch": { "CMakeLists.txt": { "if(OPENMP_FOUND)": "if(false)", "install": "#install", } }, "build": [ *cmds_cmake("imagequant_a"), cmd_copy("imagequant_a.lib", "imagequant.lib"), ], "headers": [r"*.h"], "libs": [r"imagequant.lib"], }, "harfbuzz": { "url": "https://github.com/harfbuzz/harfbuzz/archive/7.3.0.zip", "filename": "harfbuzz-7.3.0.zip", "dir": "harfbuzz-7.3.0", "license": "COPYING", "build": [ *cmds_cmake( "harfbuzz", "-DHB_HAVE_FREETYPE:BOOL=TRUE", '-DCMAKE_CXX_FLAGS="-nologo -d2FH4-"', ), ], "headers": [r"src\*.h"], "libs": [r"*.lib"], }, "fribidi": { "url": "https://github.com/fribidi/fribidi/archive/v1.0.13.zip", "filename": "fribidi-1.0.13.zip", "dir": "fribidi-1.0.13", "license": "COPYING", "build": [ cmd_copy(r"COPYING", r"{bin_dir}\fribidi-1.0.13-COPYING"), cmd_copy(r"{winbuild_dir}\fribidi.cmake", r"CMakeLists.txt"), *cmds_cmake("fribidi"), ], "bins": [r"*.dll"], }, } # based on distutils._msvccompiler from CPython 3.7.4 def find_msvs(): root = os.environ.get("ProgramFiles(x86)") or os.environ.get("ProgramFiles") if not root: print("Program Files not found") return None try: vspath = ( subprocess.check_output( [ os.path.join( root, "Microsoft Visual Studio", "Installer", "vswhere.exe" ), "-latest", "-prerelease", "-requires", "Microsoft.VisualStudio.Component.VC.Tools.x86.x64", "-property", "installationPath", "-products", "*", ] ) .decode(encoding="mbcs") .strip() ) except (subprocess.CalledProcessError, OSError, UnicodeDecodeError): print("vswhere not found") return None if not os.path.isdir(os.path.join(vspath, "VC", "Auxiliary", "Build")): print("Visual Studio seems to be missing C compiler") return None vs = { "header": [], # nmake selected by vcvarsall "nmake": "nmake.exe", "vs_dir": vspath, } # vs2017 msbuild = os.path.join(vspath, "MSBuild", "15.0", "Bin", "MSBuild.exe") if os.path.isfile(msbuild): vs["msbuild"] = f'"{msbuild}"' else: # vs2019 msbuild = os.path.join(vspath, "MSBuild", "Current", "Bin", "MSBuild.exe") if os.path.isfile(msbuild): vs["msbuild"] = f'"{msbuild}"' else: print("Visual Studio MSBuild not found") return None vcvarsall = os.path.join(vspath, "VC", "Auxiliary", "Build", "vcvarsall.bat") if not os.path.isfile(vcvarsall): print("Visual Studio vcvarsall not found") return None vs["header"].append(f'call "{vcvarsall}" {{vcvars_arch}}') return vs def extract_dep(url, filename): import tarfile import urllib.request import zipfile file = os.path.join(args.depends_dir, filename) if not os.path.exists(file): ex = None for i in range(3): try: print("Fetching %s (attempt %d)..." % (url, i + 1)) content = urllib.request.urlopen(url).read() with open(file, "wb") as f: f.write(content) break except urllib.error.URLError as e: ex = e else: raise RuntimeError(ex) print("Extracting " + filename) sources_dir_abs = os.path.abspath(sources_dir) if filename.endswith(".zip"): with zipfile.ZipFile(file) as zf: for member in zf.namelist(): member_abspath = os.path.abspath(os.path.join(sources_dir, member)) member_prefix = os.path.commonpath([sources_dir_abs, member_abspath]) if sources_dir_abs != member_prefix: msg = "Attempted Path Traversal in Zip File" raise RuntimeError(msg) zf.extractall(sources_dir) elif filename.endswith(".tar.gz") or filename.endswith(".tgz"): with tarfile.open(file, "r:gz") as tgz: for member in tgz.getnames(): member_abspath = os.path.abspath(os.path.join(sources_dir, member)) member_prefix = os.path.commonpath([sources_dir_abs, member_abspath]) if sources_dir_abs != member_prefix: msg = "Attempted Path Traversal in Tar File" raise RuntimeError(msg) tgz.extractall(sources_dir) else: msg = "Unknown archive type: " + filename raise RuntimeError(msg) def write_script(name, lines): name = os.path.join(args.build_dir, name) lines = [line.format(**prefs) for line in lines] print("Writing " + name) with open(name, "w", newline="") as f: f.write(os.linesep.join(lines)) if args.verbose: for line in lines: print(" " + line) def get_footer(dep): lines = [] for out in dep.get("headers", []): lines.append(cmd_copy(out, "{inc_dir}")) for out in dep.get("libs", []): lines.append(cmd_copy(out, "{lib_dir}")) for out in dep.get("bins", []): lines.append(cmd_copy(out, "{bin_dir}")) return lines def build_dep(name): dep = deps[name] dir = dep["dir"] file = f"build_dep_{name}.cmd" extract_dep(dep["url"], dep["filename"]) licenses = dep["license"] if isinstance(licenses, str): licenses = [licenses] license_text = "" for license_file in licenses: with open(os.path.join(sources_dir, dir, license_file)) as f: license_text += f.read() if "license_pattern" in dep: match = re.search(dep["license_pattern"], license_text, re.DOTALL) license_text = "\n".join(match.groups()) assert len(license_text) > 50 with open(os.path.join(license_dir, f"{dir}.txt"), "w") as f: print(f"Writing license {dir}.txt") f.write(license_text) for patch_file, patch_list in dep.get("patch", {}).items(): patch_file = os.path.join(sources_dir, dir, patch_file.format(**prefs)) with open(patch_file) as f: text = f.read() for patch_from, patch_to in patch_list.items(): patch_from = patch_from.format(**prefs) patch_to = patch_to.format(**prefs) assert patch_from in text text = text.replace(patch_from, patch_to) with open(patch_file, "w") as f: print(f"Patching {patch_file}") f.write(text) banner = f"Building {name} ({dir})" lines = [ "@echo " + ("=" * 70), f"@echo ==== {banner:<60} ====", "@echo " + ("=" * 70), "cd /D %s" % os.path.join(sources_dir, dir), *prefs["header"], *dep.get("build", []), *get_footer(dep), ] write_script(file, lines) return file def build_dep_all(): lines = ["@echo on"] for dep_name in deps: print() if dep_name in disabled: print(f"Skipping disabled dependency {dep_name}") continue script = build_dep(dep_name) lines.append(rf'cmd.exe /c "{{build_dir}}\{script}"') lines.append("if errorlevel 1 echo Build failed! && exit /B 1") print() lines.append("@echo All Pillow dependencies built successfully!") write_script("build_dep_all.cmd", lines) def build_pillow(): lines = [ "@echo ---- Building Pillow (build_ext %*) ----", cmd_cd("{pillow_dir}"), *prefs["header"], cmd_set("DISTUTILS_USE_SDK", "1"), # use same compiler to build Pillow cmd_set("py_vcruntime_redist", "true"), # always use /MD, never /MT r'"{python_dir}\{python_exe}" setup.py build_ext --vendor-raqm --vendor-fribidi %*', # noqa: E501 ] write_script("build_pillow.cmd", lines) if __name__ == "__main__": winbuild_dir = os.path.dirname(os.path.realpath(__file__)) pillow_dir = os.path.realpath(os.path.join(winbuild_dir, "..")) parser = argparse.ArgumentParser( prog="winbuild\\build_prepare.py", description="Download dependencies and generate build scripts for Pillow.", epilog="""Arguments can also be supplied using the environment variables PILLOW_BUILD, PILLOW_DEPS, ARCHITECTURE, PYTHON, EXECUTABLE. See winbuild\\build.rst for more information.""", ) parser.add_argument( "-v", "--verbose", action="store_true", help="print generated scripts" ) parser.add_argument( "-d", "--dir", "--build-dir", dest="build_dir", metavar="PILLOW_BUILD", default=os.environ.get("PILLOW_BUILD", os.path.join(winbuild_dir, "build")), help="build directory (default: 'winbuild\\build')", ) parser.add_argument( "--depends", dest="depends_dir", metavar="PILLOW_DEPS", default=os.environ.get("PILLOW_DEPS", os.path.join(winbuild_dir, "depends")), help="directory used to store cached dependencies " "(default: 'winbuild\\depends')", ) parser.add_argument( "--architecture", choices=architectures, default=os.environ.get( "ARCHITECTURE", ( "ARM64" if platform.machine() == "ARM64" else ("x86" if struct.calcsize("P") == 4 else "x64") ), ), help="build architecture (default: same as host Python)", ) parser.add_argument( "--python", dest="python_dir", metavar="PYTHON", default=os.environ.get("PYTHON"), help="Python install directory (default: use host Python)", ) parser.add_argument( "--executable", dest="python_exe", metavar="EXECUTABLE", default=os.environ.get("EXECUTABLE", "python.exe"), help="Python executable (default: use host Python)", ) parser.add_argument( "--nmake", dest="cmake_generator", action="store_const", const="NMake Makefiles", default="Ninja", help="build dependencies using NMake instead of Ninja", ) parser.add_argument( "--no-imagequant", action="store_true", help="skip GPL-licensed optional dependency libimagequant", ) parser.add_argument( "--no-fribidi", "--no-raqm", action="store_true", help="skip LGPL-licensed optional dependency FriBiDi", ) args = parser.parse_args() arch_prefs = architectures[args.architecture] print("Target architecture:", args.architecture) if args.python_dir is None: args.python_dir = os.path.dirname(os.path.realpath(sys.executable)) args.python_exe = os.path.basename(sys.executable) print("Target Python:", os.path.join(args.python_dir, args.python_exe)) msvs = find_msvs() if msvs is None: msg = "Visual Studio not found. Please install Visual Studio 2017 or newer." raise RuntimeError(msg) print("Found Visual Studio at:", msvs["vs_dir"]) # dependency cache directory args.depends_dir = os.path.abspath(args.depends_dir) os.makedirs(args.depends_dir, exist_ok=True) print("Caching dependencies in:", args.depends_dir) args.build_dir = os.path.abspath(args.build_dir) print("Using output directory:", args.build_dir) # build directory for *.h files inc_dir = os.path.join(args.build_dir, "inc") # build directory for *.lib files lib_dir = os.path.join(args.build_dir, "lib") # build directory for *.bin files bin_dir = os.path.join(args.build_dir, "bin") # directory for storing project files sources_dir = os.path.join(args.build_dir, "src") # copy dependency licenses to this directory license_dir = os.path.join(args.build_dir, "license") shutil.rmtree(args.build_dir, ignore_errors=True) os.makedirs(args.build_dir, exist_ok=False) for path in [inc_dir, lib_dir, bin_dir, sources_dir, license_dir]: os.makedirs(path, exist_ok=True) disabled = [] if args.no_imagequant: disabled += ["libimagequant"] if args.no_fribidi: disabled += ["fribidi"] prefs = { # Python paths / preferences "python_dir": args.python_dir, "python_exe": args.python_exe, "architecture": args.architecture, **arch_prefs, # Pillow paths "pillow_dir": pillow_dir, "winbuild_dir": winbuild_dir, # Build paths "build_dir": args.build_dir, "inc_dir": inc_dir, "lib_dir": lib_dir, "bin_dir": bin_dir, "src_dir": sources_dir, "license_dir": license_dir, # Compilers / Tools **msvs, "cmake": "cmake.exe", # TODO find CMAKE automatically "cmake_generator": args.cmake_generator, # TODO find NASM automatically # script header "header": sum([header, msvs["header"], ["@echo on"]], []), } for k, v in deps.items(): prefs[f"dir_{k}"] = os.path.join(sources_dir, v["dir"]) print() write_script(".gitignore", ["*"]) build_dep_all() if args.verbose: print() build_pillow()