Pillow/setup.py

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

1017 lines
36 KiB
Python
Raw Normal View History

2013-09-28 17:28:16 +04:00
# > pyroma .
# ------------------------------
# Checking .
# Found Pillow
# ------------------------------
# Final rating: 10/10
# Your cheese is so fresh most people think it's a cream: Mascarpone
# ------------------------------
from __future__ import annotations
2010-11-28 23:15:53 +03:00
import os
import re
import shutil
2010-11-28 23:15:53 +03:00
import struct
import subprocess
import sys
import warnings
from setuptools import Extension, setup
2020-09-01 20:16:46 +03:00
from setuptools.command.build_ext import build_ext
2010-11-28 23:15:53 +03:00
def get_version():
version_file = "src/PIL/_version.py"
with open(version_file, encoding="utf-8") as f:
exec(compile(f.read(), version_file, "exec"))
return locals()["__version__"]
PILLOW_VERSION = get_version()
FREETYPE_ROOT = None
2020-11-25 22:33:33 +03:00
HARFBUZZ_ROOT = None
FRIBIDI_ROOT = None
IMAGEQUANT_ROOT = None
JPEG2K_ROOT = None
JPEG_ROOT = None
LCMS_ROOT = None
TIFF_ROOT = None
ZLIB_ROOT = None
2021-01-09 19:00:27 +03:00
FUZZING_BUILD = "LIB_FUZZING_ENGINE" in os.environ
if sys.platform == "win32" and sys.version_info >= (3, 13):
2020-10-12 10:38:36 +03:00
import atexit
atexit.register(
lambda: warnings.warn(
f"Pillow {PILLOW_VERSION} does not support Python "
f"{sys.version_info.major}.{sys.version_info.minor} and does not provide "
"prebuilt Windows binaries. We do not recommend building from source on "
"Windows.",
RuntimeWarning,
)
2019-06-13 18:54:57 +03:00
)
_IMAGING = ("decode", "encode", "map", "display", "outline", "path")
2010-11-28 23:15:53 +03:00
_LIB_IMAGING = (
2019-06-13 18:54:57 +03:00
"Access",
"AlphaComposite",
"Resample",
2019-11-24 04:13:48 +03:00
"Reduce",
2019-06-13 18:54:57 +03:00
"Bands",
"BcnDecode",
"BitDecode",
"Blend",
"Chops",
"ColorLUT",
"Convert",
"ConvertYCbCr",
"Copy",
"Crop",
"Dib",
"Draw",
"Effects",
"EpsEncode",
"File",
"Fill",
"Filter",
"FliDecode",
"Geometry",
"GetBBox",
"GifDecode",
"GifEncode",
"HexDecode",
"Histo",
"JpegDecode",
"JpegEncode",
"Matrix",
"ModeFilter",
"Negative",
"Offset",
"Pack",
"PackDecode",
"Palette",
"Paste",
"Quant",
"QuantOctree",
"QuantHash",
"QuantHeap",
"PcdDecode",
"PcxDecode",
"PcxEncode",
"Point",
"RankFilter",
"RawDecode",
"RawEncode",
"Storage",
"SgiRleDecode",
"SunRleDecode",
"TgaRleDecode",
"TgaRleEncode",
"Unpack",
"UnpackYCC",
"UnsharpMask",
"XbmDecode",
"XbmEncode",
"ZipDecode",
"ZipEncode",
"TiffDecode",
"Jpeg2KDecode",
"Jpeg2KEncode",
"BoxBlur",
"QuantPngQuant",
"codec_fd",
)
2010-11-28 23:15:53 +03:00
DEBUG = False
2010-11-28 23:15:53 +03:00
2017-12-04 15:35:05 +03:00
class DependencyException(Exception):
pass
class RequiredDependencyException(Exception):
pass
2020-09-01 20:16:46 +03:00
PLATFORM_MINGW = os.name == "nt" and "GCC" in sys.version
2017-09-19 15:44:56 +03:00
2017-12-04 15:35:05 +03:00
2016-03-30 19:16:10 +03:00
def _dbg(s, tp=None):
if DEBUG:
if tp:
print(s % tp)
return
print(s)
2010-11-28 23:15:53 +03:00
def _find_library_dirs_ldconfig():
# Based on ctypes.util from Python 2
ldconfig = "ldconfig" if shutil.which("ldconfig") else "/sbin/ldconfig"
if sys.platform.startswith("linux") or sys.platform.startswith("gnu"):
2023-06-27 07:43:58 +03:00
if struct.calcsize("l") == 4:
machine = os.uname()[4] + "-32"
else:
machine = os.uname()[4] + "-64"
mach_map = {
2023-06-27 07:43:58 +03:00
"x86_64-64": "libc6,x86-64",
"ppc64-64": "libc6,64bit",
"sparc64-64": "libc6,64bit",
"s390x-64": "libc6,64bit",
"ia64-64": "libc6,IA-64",
2019-06-13 18:54:57 +03:00
}
abi_type = mach_map.get(machine, "libc6")
2018-12-26 14:09:12 +03:00
# Assuming GLIBC's ldconfig (with option -p)
# Alpine Linux uses musl that can't print cache
args = [ldconfig, "-p"]
2022-03-04 08:42:24 +03:00
expr = rf".*\({abi_type}.*\) => (.*)"
env = dict(os.environ)
2019-06-13 18:54:57 +03:00
env["LC_ALL"] = "C"
env["LANG"] = "C"
elif sys.platform.startswith("freebsd"):
args = [ldconfig, "-r"]
2019-06-13 18:54:57 +03:00
expr = r".* => (.*)"
env = {}
try:
p = subprocess.Popen(
args, stderr=subprocess.DEVNULL, stdout=subprocess.PIPE, env=env
)
except OSError: # E.g. command not found
return []
[data, _] = p.communicate()
if isinstance(data, bytes):
2021-12-05 07:59:27 +03:00
data = data.decode("latin1")
dirs = []
for dll in re.findall(expr, data):
dir = os.path.dirname(dll)
if dir not in dirs:
dirs.append(dir)
return dirs
2016-03-30 18:19:23 +03:00
def _add_directory(path, subdir, where=None):
if subdir is None:
2013-12-11 13:13:06 +04:00
return
2016-03-30 18:19:23 +03:00
subdir = os.path.realpath(subdir)
if os.path.isdir(subdir) and subdir not in path:
2010-11-28 23:15:53 +03:00
if where is None:
2019-06-13 18:54:57 +03:00
_dbg("Appending path %s", subdir)
2016-03-30 18:19:23 +03:00
path.append(subdir)
2010-11-28 23:15:53 +03:00
else:
2019-06-13 18:54:57 +03:00
_dbg("Inserting path %s", subdir)
2016-03-30 18:19:23 +03:00
path.insert(where, subdir)
elif subdir in path and where is not None:
path.remove(subdir)
path.insert(where, subdir)
2010-11-28 23:15:53 +03:00
def _find_include_file(self, include):
for directory in self.compiler.include_dirs:
2019-06-13 18:54:57 +03:00
_dbg("Checking for include file %s in %s", (include, directory))
2010-11-28 23:15:53 +03:00
if os.path.isfile(os.path.join(directory, include)):
2019-06-13 18:54:57 +03:00
_dbg("Found %s", include)
2010-11-28 23:15:53 +03:00
return 1
return 0
def _find_library_file(self, library):
2016-11-07 15:35:23 +03:00
ret = self.compiler.find_library_file(self.compiler.library_dirs, library)
2016-03-30 19:16:10 +03:00
if ret:
2019-06-13 18:54:57 +03:00
_dbg("Found library %s at %s", (library, ret))
2016-03-30 19:16:10 +03:00
else:
2019-06-13 18:54:57 +03:00
_dbg("Couldn't find library %s in %s", (library, self.compiler.library_dirs))
2016-03-30 19:16:10 +03:00
return ret
2013-05-12 03:56:02 +04:00
2010-11-28 23:15:53 +03:00
2020-11-25 19:27:12 +03:00
def _find_include_dir(self, dirname, include):
for directory in self.compiler.include_dirs:
_dbg("Checking for include file %s in %s", (include, directory))
if os.path.isfile(os.path.join(directory, include)):
_dbg("Found %s in %s", (include, directory))
return True
subdir = os.path.join(directory, dirname)
_dbg("Checking for include file %s in %s", (include, subdir))
if os.path.isfile(os.path.join(subdir, include)):
_dbg("Found %s in %s", (include, subdir))
return subdir
def _cmd_exists(cmd: str) -> bool:
if "PATH" not in os.environ:
return False
return any(
os.access(os.path.join(path, cmd), os.X_OK)
for path in os.environ["PATH"].split(os.pathsep)
)
2010-11-28 23:20:53 +03:00
2017-12-04 15:35:05 +03:00
def _pkg_config(name):
command = os.environ.get("PKG_CONFIG", "pkg-config")
for keep_system in (True, False):
try:
command_libs = [command, "--libs-only-L", name]
command_cflags = [command, "--cflags-only-I", name]
2022-05-03 02:19:09 +03:00
stderr = None
if keep_system:
command_libs.append("--keep-system-libs")
command_cflags.append("--keep-system-cflags")
2022-05-03 02:19:09 +03:00
stderr = subprocess.DEVNULL
if not DEBUG:
command_libs.append("--silence-errors")
command_cflags.append("--silence-errors")
libs = re.split(
r"(^|\s+)-L",
2022-05-03 02:19:09 +03:00
subprocess.check_output(command_libs, stderr=stderr)
.decode("utf8")
.strip(),
)[::2][1:]
cflags = re.split(
r"(^|\s+)-I",
subprocess.check_output(command_cflags).decode("utf8").strip(),
)[::2][1:]
return libs, cflags
except Exception:
pass
2017-12-04 15:35:05 +03:00
2010-11-28 23:15:53 +03:00
class pil_build_ext(build_ext):
class feature:
2019-06-13 18:54:57 +03:00
features = [
"zlib",
"jpeg",
"tiff",
"freetype",
"raqm",
2019-06-13 18:54:57 +03:00
"lcms",
"webp",
"webpmux",
"jpeg2000",
"imagequant",
2019-09-19 19:57:59 +03:00
"xcb",
2019-06-13 18:54:57 +03:00
]
2019-06-13 18:54:57 +03:00
required = {"jpeg", "zlib"}
vendor = set()
def __init__(self):
for f in self.features:
setattr(self, f, None)
def require(self, feat):
return feat in self.required
2014-06-24 10:34:05 +04:00
def want(self, feat):
return getattr(self, feat) is None
def want_vendor(self, feat):
return feat in self.vendor
def __iter__(self):
yield from self.features
feature = feature()
2019-06-13 18:54:57 +03:00
user_options = (
build_ext.user_options
+ [(f"disable-{x}", None, f"Disable support for {x}") for x in feature]
+ [(f"enable-{x}", None, f"Enable support for {x}") for x in feature]
+ [
(f"vendor-{x}", None, f"Use vendored version of {x}")
for x in ("raqm", "fribidi")
]
2019-06-13 18:54:57 +03:00
+ [
("disable-platform-guessing", None, "Disable platform guessing on Linux"),
("debug", None, "Debug logging"),
]
+ [("add-imaging-libs=", None, "Add libs to _imaging build")]
)
def initialize_options(self):
self.disable_platform_guessing = None
2018-10-08 11:43:11 +03:00
self.add_imaging_libs = ""
build_ext.initialize_options(self)
for x in self.feature:
setattr(self, f"disable_{x}", None)
setattr(self, f"enable_{x}", None)
for x in ("raqm", "fribidi"):
setattr(self, f"vendor_{x}", None)
def finalize_options(self):
build_ext.finalize_options(self)
2016-03-30 19:16:10 +03:00
if self.debug:
global DEBUG
DEBUG = True
if not self.parallel:
# If --parallel (or -j) wasn't specified, we want to reproduce the same
# behavior as before, that is, auto-detect the number of jobs.
try:
self.parallel = int(
os.environ.get("MAX_CONCURRENCY", min(4, os.cpu_count()))
)
except TypeError:
self.parallel = None
for x in self.feature:
if getattr(self, f"disable_{x}"):
setattr(self.feature, x, False)
2015-09-22 23:07:31 +03:00
self.feature.required.discard(x)
2019-06-13 18:54:57 +03:00
_dbg("Disabling %s", x)
if getattr(self, f"enable_{x}"):
msg = f"Conflicting options: --enable-{x} and --disable-{x}"
raise ValueError(msg)
if x == "freetype":
_dbg("--disable-freetype implies --disable-raqm")
if getattr(self, "enable_raqm"):
msg = (
"Conflicting options: --enable-raqm and --disable-freetype"
)
raise ValueError(msg)
setattr(self, "disable_raqm", True)
if getattr(self, f"enable_{x}"):
2019-06-13 18:54:57 +03:00
_dbg("Requiring %s", x)
2015-09-22 23:07:31 +03:00
self.feature.required.add(x)
if x == "raqm":
_dbg("--enable-raqm implies --enable-freetype")
self.feature.required.add("freetype")
for x in ("raqm", "fribidi"):
if getattr(self, f"vendor_{x}"):
2020-11-25 19:29:43 +03:00
if getattr(self, "disable_raqm"):
msg = f"Conflicting options: --vendor-{x} and --disable-raqm"
raise ValueError(msg)
if x == "fribidi" and not getattr(self, "vendor_raqm"):
msg = f"Conflicting options: --vendor-{x} and not --vendor-raqm"
raise ValueError(msg)
_dbg("Using vendored version of %s", x)
self.feature.vendor.add(x)
def _update_extension(self, name, libraries, define_macros=None, sources=None):
2020-09-01 20:16:46 +03:00
for extension in self.extensions:
if extension.name == name:
extension.libraries += libraries
if define_macros is not None:
extension.define_macros += define_macros
if sources is not None:
extension.sources += sources
if FUZZING_BUILD:
extension.language = "c++"
extension.extra_link_args = ["--stdlib=libc++"]
2020-09-01 20:16:46 +03:00
break
def _remove_extension(self, name):
for extension in self.extensions:
if extension.name == name:
self.extensions.remove(extension)
break
def get_macos_sdk_path(self):
try:
sdk_path = (
subprocess.check_output(["xcrun", "--show-sdk-path"])
.strip()
.decode("latin1")
)
except Exception:
sdk_path = None
if (
not sdk_path
or sdk_path == "/Applications/Xcode.app/Contents/Developer"
"/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk"
):
commandlinetools_sdk_path = (
"/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk"
)
if os.path.exists(commandlinetools_sdk_path):
sdk_path = commandlinetools_sdk_path
return sdk_path
2010-11-28 23:15:53 +03:00
def build_extensions(self):
library_dirs = []
include_dirs = []
pkg_config = None
if _cmd_exists(os.environ.get("PKG_CONFIG", "pkg-config")):
pkg_config = _pkg_config
#
# add configured kits
for root_name, lib_name in {
"JPEG_ROOT": "libjpeg",
"JPEG2K_ROOT": "libopenjp2",
"TIFF_ROOT": ("libtiff-5", "libtiff-4"),
"ZLIB_ROOT": "zlib",
"FREETYPE_ROOT": "freetype2",
"HARFBUZZ_ROOT": "harfbuzz",
"FRIBIDI_ROOT": "fribidi",
"LCMS_ROOT": "lcms2",
"IMAGEQUANT_ROOT": "libimagequant",
}.items():
root = globals()[root_name]
if root is None and root_name in os.environ:
prefix = os.environ[root_name]
2019-06-13 18:54:57 +03:00
root = (os.path.join(prefix, "lib"), os.path.join(prefix, "include"))
if root is None and pkg_config:
if isinstance(lib_name, tuple):
for lib_name2 in lib_name:
_dbg(f"Looking for `{lib_name2}` using pkg-config.")
root = pkg_config(lib_name2)
if root:
break
else:
_dbg(f"Looking for `{lib_name}` using pkg-config.")
root = pkg_config(lib_name)
if isinstance(root, tuple):
lib_root, include_root = root
else:
lib_root = include_root = root
if lib_root is not None:
2023-04-05 09:15:42 +03:00
if not isinstance(lib_root, (tuple, list)):
lib_root = (lib_root,)
for lib_dir in lib_root:
_add_directory(library_dirs, lib_dir)
if include_root is not None:
2023-04-05 09:15:42 +03:00
if not isinstance(include_root, (tuple, list)):
include_root = (include_root,)
for include_dir in include_root:
_add_directory(include_dirs, include_dir)
# respect CFLAGS/CPPFLAGS/LDFLAGS
for k in ("CFLAGS", "CPPFLAGS", "LDFLAGS"):
if k in os.environ:
2019-06-13 18:54:57 +03:00
for match in re.finditer(r"-I([^\s]+)", os.environ[k]):
_add_directory(include_dirs, match.group(1))
2019-06-13 18:54:57 +03:00
for match in re.finditer(r"-L([^\s]+)", os.environ[k]):
_add_directory(library_dirs, match.group(1))
# include, rpath, if set as environment variables:
2019-06-13 18:54:57 +03:00
for k in ("C_INCLUDE_PATH", "CPATH", "INCLUDE"):
if k in os.environ:
for d in os.environ[k].split(os.path.pathsep):
_add_directory(include_dirs, d)
2019-06-13 18:54:57 +03:00
for k in ("LD_RUN_PATH", "LIBRARY_PATH", "LIB"):
if k in os.environ:
for d in os.environ[k].split(os.path.pathsep):
_add_directory(library_dirs, d)
2020-07-24 12:58:17 +03:00
_add_directory(library_dirs, os.path.join(sys.prefix, "lib"))
_add_directory(include_dirs, os.path.join(sys.prefix, "include"))
2010-11-28 23:15:53 +03:00
#
# add platform directories
2016-05-01 12:57:50 +03:00
if self.disable_platform_guessing:
pass
2016-05-01 12:57:50 +03:00
elif sys.platform == "cygwin":
2010-11-28 23:15:53 +03:00
# pythonX.Y.dll.a is in the /usr/lib/pythonX.Y/config directory
2023-05-21 07:38:05 +03:00
self.compiler.shared_lib_extension = ".dll.a"
2019-06-13 18:54:57 +03:00
_add_directory(
library_dirs,
2019-08-18 12:32:23 +03:00
os.path.join(
"/usr/lib", "python{}.{}".format(*sys.version_info), "config"
),
2019-06-13 18:54:57 +03:00
)
2010-11-28 23:15:53 +03:00
elif sys.platform == "darwin":
# attempt to make sure we pick freetype2 over other versions
_add_directory(include_dirs, "/sw/include/freetype2")
_add_directory(include_dirs, "/sw/lib/freetype2/include")
# fink installation directories
_add_directory(library_dirs, "/sw/lib")
_add_directory(include_dirs, "/sw/include")
# darwin ports installation directories
_add_directory(library_dirs, "/opt/local/lib")
_add_directory(include_dirs, "/opt/local/include")
# if Homebrew is installed, use its lib and include directories
2013-10-02 19:36:47 +04:00
try:
2019-06-13 18:54:57 +03:00
prefix = (
subprocess.check_output(["brew", "--prefix"])
.strip()
.decode("latin1")
)
2017-12-04 15:35:05 +03:00
except Exception:
# Homebrew not installed
prefix = None
ft_prefix = None
if prefix:
# add Homebrew's include and lib directories
2019-06-13 18:54:57 +03:00
_add_directory(library_dirs, os.path.join(prefix, "lib"))
_add_directory(include_dirs, os.path.join(prefix, "include"))
2020-09-01 20:16:46 +03:00
_add_directory(
include_dirs, os.path.join(prefix, "opt", "zlib", "include")
)
2019-06-13 18:54:57 +03:00
ft_prefix = os.path.join(prefix, "opt", "freetype")
if ft_prefix and os.path.isdir(ft_prefix):
# freetype might not be linked into Homebrew's prefix
2019-06-13 18:54:57 +03:00
_add_directory(library_dirs, os.path.join(ft_prefix, "lib"))
_add_directory(include_dirs, os.path.join(ft_prefix, "include"))
else:
2014-06-24 10:34:05 +04:00
# fall back to freetype from XQuartz if
# Homebrew's freetype is missing
_add_directory(library_dirs, "/usr/X11/lib")
_add_directory(include_dirs, "/usr/X11/include")
sdk_path = self.get_macos_sdk_path()
if sdk_path:
_add_directory(library_dirs, os.path.join(sdk_path, "usr", "lib"))
_add_directory(include_dirs, os.path.join(sdk_path, "usr", "include"))
for extension in self.extensions:
extension.extra_compile_args = ["-Wno-nullability-completeness"]
2019-06-13 18:54:57 +03:00
elif (
sys.platform.startswith("linux")
or sys.platform.startswith("gnu")
or sys.platform.startswith("freebsd")
):
for dirname in _find_library_dirs_ldconfig():
_add_directory(library_dirs, dirname)
if sys.platform.startswith("linux") and os.environ.get("ANDROID_ROOT"):
# termux support for android.
# system libraries (zlib) are installed in /system/lib
# headers are at $PREFIX/include
# user libs are at $PREFIX/lib
2018-12-27 14:11:24 +03:00
_add_directory(
2021-10-24 14:38:13 +03:00
library_dirs,
2023-06-27 07:43:58 +03:00
os.path.join(
os.environ["ANDROID_ROOT"],
"lib" if struct.calcsize("l") == 4 else "lib64",
),
2018-12-27 14:11:24 +03:00
)
2013-11-14 16:10:19 +04:00
elif sys.platform.startswith("netbsd"):
2015-07-28 12:59:52 +03:00
_add_directory(library_dirs, "/usr/pkg/lib")
_add_directory(include_dirs, "/usr/pkg/include")
2013-11-14 16:10:19 +04:00
2015-07-27 19:17:49 +03:00
elif sys.platform.startswith("sunos5"):
_add_directory(library_dirs, "/opt/local/lib")
_add_directory(include_dirs, "/opt/local/include")
2015-09-11 12:28:19 +03:00
2010-11-28 23:15:53 +03:00
# FIXME: check /opt/stuff directories here?
# standard locations
if not self.disable_platform_guessing:
_add_directory(library_dirs, "/usr/local/lib")
_add_directory(include_dirs, "/usr/local/include")
2010-11-28 23:15:53 +03:00
_add_directory(library_dirs, "/usr/lib")
_add_directory(include_dirs, "/usr/include")
2016-05-30 16:28:08 +03:00
# alpine, at least
_add_directory(library_dirs, "/lib")
2010-11-28 23:15:53 +03:00
2014-03-14 18:35:09 +04:00
if sys.platform == "win32":
# on Windows, look for the OpenJPEG libraries in the location that
# the official installer puts them
2019-06-13 18:54:57 +03:00
program_files = os.environ.get("ProgramFiles", "")
2014-05-27 15:43:54 +04:00
best_version = (0, 0)
best_path = None
for name in os.listdir(program_files):
2019-06-13 18:54:57 +03:00
if name.startswith("OpenJPEG "):
version = tuple(int(x) for x in name[9:].strip().split("."))
2014-05-27 15:43:54 +04:00
if version > best_version:
best_version = version
best_path = os.path.join(program_files, name)
if best_path:
2019-06-13 18:54:57 +03:00
_dbg("Adding %s to search list", best_path)
_add_directory(library_dirs, os.path.join(best_path, "lib"))
_add_directory(include_dirs, os.path.join(best_path, "include"))
2014-03-14 18:35:09 +04:00
2010-11-28 23:15:53 +03:00
#
# insert new dirs *before* default libs, to avoid conflicts
# between Python PYD stub libs and real libraries
self.compiler.library_dirs = library_dirs + self.compiler.library_dirs
self.compiler.include_dirs = include_dirs + self.compiler.include_dirs
#
# look for available libraries
feature = self.feature
2019-06-13 18:54:57 +03:00
if feature.want("zlib"):
_dbg("Looking for zlib")
if _find_include_file(self, "zlib.h"):
if _find_library_file(self, "z"):
feature.zlib = "z"
2019-06-13 18:54:57 +03:00
elif sys.platform == "win32" and _find_library_file(self, "zlib"):
feature.zlib = "zlib" # alternative name
2019-06-13 18:54:57 +03:00
if feature.want("jpeg"):
_dbg("Looking for jpeg")
if _find_include_file(self, "jpeglib.h"):
if _find_library_file(self, "jpeg"):
feature.jpeg = "jpeg"
2019-06-13 18:54:57 +03:00
elif sys.platform == "win32" and _find_library_file(self, "libjpeg"):
feature.jpeg = "libjpeg" # alternative name
feature.openjpeg_version = None
2019-06-13 18:54:57 +03:00
if feature.want("jpeg2000"):
_dbg("Looking for jpeg2000")
2014-05-27 15:43:54 +04:00
best_version = None
best_path = None
2014-06-24 10:34:05 +04:00
2014-05-27 15:43:54 +04:00
# Find the best version
for directory in self.compiler.include_dirs:
2019-06-13 18:54:57 +03:00
_dbg("Checking for openjpeg-#.# in %s", directory)
try:
listdir = os.listdir(directory)
2014-08-28 15:44:19 +04:00
except Exception:
# OSError, FileNotFoundError
continue
for name in listdir:
2019-06-13 18:54:57 +03:00
if name.startswith("openjpeg-") and os.path.isfile(
os.path.join(directory, name, "openjpeg.h")
):
_dbg("Found openjpeg.h in %s/%s", (directory, name))
version = tuple(int(x) for x in name[9:].split("."))
2014-05-27 15:43:54 +04:00
if best_version is None or version > best_version:
best_version = version
best_path = os.path.join(directory, name)
2019-06-13 18:54:57 +03:00
_dbg(
"Best openjpeg version %s so far in %s",
(best_version, best_path),
)
2014-05-27 15:43:54 +04:00
2019-06-13 18:54:57 +03:00
if best_version and _find_library_file(self, "openjp2"):
2014-05-27 15:43:54 +04:00
# Add the directory to the include path so we can include
# <openjpeg.h> rather than having to cope with the versioned
# include path
_add_directory(self.compiler.include_dirs, best_path, 0)
2019-06-13 18:54:57 +03:00
feature.jpeg2000 = "openjp2"
feature.openjpeg_version = ".".join(str(x) for x in best_version)
2014-06-24 10:34:05 +04:00
2019-06-13 18:54:57 +03:00
if feature.want("imagequant"):
_dbg("Looking for imagequant")
if _find_include_file(self, "libimagequant.h"):
if _find_library_file(self, "imagequant"):
feature.imagequant = "imagequant"
elif _find_library_file(self, "libimagequant"):
feature.imagequant = "libimagequant"
2019-06-13 18:54:57 +03:00
if feature.want("tiff"):
_dbg("Looking for tiff")
if _find_include_file(self, "tiff.h"):
2016-03-30 19:16:10 +03:00
if _find_library_file(self, "tiff"):
feature.tiff = "tiff"
2019-06-13 18:54:57 +03:00
if sys.platform in ["win32", "darwin"] and _find_library_file(
self, "libtiff"
):
2016-03-30 19:16:10 +03:00
feature.tiff = "libtiff"
2019-06-13 18:54:57 +03:00
if feature.want("freetype"):
_dbg("Looking for freetype")
if _find_library_file(self, "freetype"):
# look for freetype2 include files
freetype_version = 0
2016-03-30 18:19:23 +03:00
for subdir in self.compiler.include_dirs:
2019-06-13 18:54:57 +03:00
_dbg("Checking for include file %s in %s", ("ft2build.h", subdir))
2016-03-30 18:19:23 +03:00
if os.path.isfile(os.path.join(subdir, "ft2build.h")):
2019-06-13 18:54:57 +03:00
_dbg("Found %s in %s", ("ft2build.h", subdir))
freetype_version = 21
2016-03-30 18:19:23 +03:00
subdir = os.path.join(subdir, "freetype2")
break
2016-03-30 18:19:23 +03:00
subdir = os.path.join(subdir, "freetype2")
2019-06-13 18:54:57 +03:00
_dbg("Checking for include file %s in %s", ("ft2build.h", subdir))
2016-03-30 18:19:23 +03:00
if os.path.isfile(os.path.join(subdir, "ft2build.h")):
2019-06-13 18:54:57 +03:00
_dbg("Found %s in %s", ("ft2build.h", subdir))
freetype_version = 21
break
if freetype_version:
feature.freetype = "freetype"
2016-03-30 18:19:23 +03:00
if subdir:
_add_directory(self.compiler.include_dirs, subdir, 0)
2020-11-25 19:27:12 +03:00
if feature.freetype and feature.want("raqm"):
if not feature.want_vendor("raqm"): # want system Raqm
_dbg("Looking for Raqm")
if _find_include_file(self, "raqm.h"):
if _find_library_file(self, "raqm"):
2020-11-25 19:27:12 +03:00
feature.raqm = "raqm"
elif _find_library_file(self, "libraqm"):
2020-11-25 19:27:12 +03:00
feature.raqm = "libraqm"
else: # want to build Raqm from src/thirdparty
_dbg("Looking for HarfBuzz")
2020-11-25 19:27:12 +03:00
feature.harfbuzz = None
hb_dir = _find_include_dir(self, "harfbuzz", "hb.h")
if hb_dir:
if isinstance(hb_dir, str):
_add_directory(self.compiler.include_dirs, hb_dir, 0)
if _find_library_file(self, "harfbuzz"):
feature.harfbuzz = "harfbuzz"
if feature.harfbuzz:
if not feature.want_vendor("fribidi"): # want system FriBiDi
_dbg("Looking for FriBiDi")
2020-11-25 19:27:12 +03:00
feature.fribidi = None
fribidi_dir = _find_include_dir(self, "fribidi", "fribidi.h")
if fribidi_dir:
if isinstance(fribidi_dir, str):
_add_directory(
self.compiler.include_dirs, fribidi_dir, 0
)
if _find_library_file(self, "fribidi"):
2020-11-25 19:27:12 +03:00
feature.fribidi = "fribidi"
feature.raqm = True
else: # want to build FriBiDi shim from src/thirdparty
feature.raqm = True
2020-11-25 14:21:42 +03:00
2019-06-13 18:54:57 +03:00
if feature.want("lcms"):
_dbg("Looking for lcms")
2013-10-02 10:05:56 +04:00
if _find_include_file(self, "lcms2.h"):
if _find_library_file(self, "lcms2"):
2014-08-23 03:14:19 +04:00
feature.lcms = "lcms2"
elif _find_library_file(self, "lcms2_static"):
2015-07-08 08:32:50 +03:00
# alternate Windows name.
2014-08-23 03:14:19 +04:00
feature.lcms = "lcms2_static"
2010-11-28 23:15:53 +03:00
2019-06-13 18:54:57 +03:00
if feature.want("webp"):
_dbg("Looking for webp")
if _find_include_file(self, "webp/encode.h") and _find_include_file(
self, "webp/decode.h"
):
2014-06-24 10:34:05 +04:00
# In Google's precompiled zip it is call "libwebp":
if _find_library_file(self, "webp"):
feature.webp = "webp"
2014-08-23 04:04:26 +04:00
elif _find_library_file(self, "libwebp"):
feature.webp = "libwebp"
2013-03-12 18:30:59 +04:00
2019-06-13 18:54:57 +03:00
if feature.want("webpmux"):
_dbg("Looking for webpmux")
if _find_include_file(self, "webp/mux.h") and _find_include_file(
self, "webp/demux.h"
):
if _find_library_file(self, "webpmux") and _find_library_file(
self, "webpdemux"
):
feature.webpmux = "webpmux"
2019-06-13 18:54:57 +03:00
if _find_library_file(self, "libwebpmux") and _find_library_file(
self, "libwebpdemux"
):
2014-08-23 04:04:26 +04:00
feature.webpmux = "libwebpmux"
2019-09-19 19:57:59 +03:00
if feature.want("xcb"):
_dbg("Looking for xcb")
if _find_include_file(self, "xcb/xcb.h"):
if _find_library_file(self, "xcb"):
feature.xcb = "xcb"
for f in feature:
if not getattr(feature, f) and feature.require(f):
2019-06-13 18:54:57 +03:00
if f in ("jpeg", "zlib"):
raise RequiredDependencyException(f)
raise DependencyException(f)
2010-11-28 23:15:53 +03:00
#
# core library
2018-10-08 11:43:11 +03:00
libs = self.add_imaging_libs.split()
2010-11-28 23:15:53 +03:00
defs = []
if feature.tiff:
libs.append(feature.tiff)
defs.append(("HAVE_LIBTIFF", None))
if sys.platform == "win32":
# This define needs to be defined if-and-only-if it was defined
# when compiling LibTIFF. LibTIFF doesn't expose it in `tiffconf.h`,
# so we have to guess; by default it is defined in all Windows builds.
# See #4237, #5243, #5359 for more information.
defs.append(("USE_WIN32_FILEIO", None))
2010-11-28 23:15:53 +03:00
if feature.jpeg:
libs.append(feature.jpeg)
defs.append(("HAVE_LIBJPEG", None))
if feature.jpeg2000:
libs.append(feature.jpeg2000)
defs.append(("HAVE_OPENJPEG", None))
2020-05-24 02:07:42 +03:00
if sys.platform == "win32" and not PLATFORM_MINGW:
2014-03-29 07:29:58 +04:00
defs.append(("OPJ_STATIC", None))
2010-11-28 23:15:53 +03:00
if feature.zlib:
libs.append(feature.zlib)
defs.append(("HAVE_LIBZ", None))
if feature.imagequant:
libs.append(feature.imagequant)
defs.append(("HAVE_LIBIMAGEQUANT", None))
2019-09-19 19:57:59 +03:00
if feature.xcb:
libs.append(feature.xcb)
defs.append(("HAVE_XCB", None))
2010-11-28 23:15:53 +03:00
if sys.platform == "win32":
libs.extend(["kernel32", "user32", "gdi32"])
if struct.unpack("h", b"\0\1")[0] == 1:
2010-11-28 23:15:53 +03:00
defs.append(("WORDS_BIGENDIAN", None))
2023-05-27 16:55:28 +03:00
defs.append(("PILLOW_VERSION", f'"{PILLOW_VERSION}"'))
2017-04-19 17:39:39 +03:00
2020-09-01 20:16:46 +03:00
self._update_extension("PIL._imaging", libs, defs)
2010-11-28 23:15:53 +03:00
#
# additional libraries
if feature.freetype:
srcs = []
2016-01-27 08:09:26 +03:00
libs = ["freetype"]
defs = []
if feature.raqm:
if not feature.want_vendor("raqm"): # using system Raqm
defs.append(("HAVE_RAQM", None))
defs.append(("HAVE_RAQM_SYSTEM", None))
libs.append(feature.raqm)
else: # building Raqm from src/thirdparty
defs.append(("HAVE_RAQM", None))
srcs.append("src/thirdparty/raqm/raqm.c")
libs.append(feature.harfbuzz)
if not feature.want_vendor("fribidi"): # using system FriBiDi
defs.append(("HAVE_FRIBIDI_SYSTEM", None))
libs.append(feature.fribidi)
else: # building FriBiDi shim from src/thirdparty
srcs.append("src/thirdparty/fribidi-shim/fribidi.c")
self._update_extension("PIL._imagingft", libs, defs, srcs)
2020-09-01 20:16:46 +03:00
else:
self._remove_extension("PIL._imagingft")
2010-11-28 23:15:53 +03:00
2016-03-30 19:16:10 +03:00
if feature.lcms:
2010-11-28 23:15:53 +03:00
extra = []
if sys.platform == "win32":
extra.extend(["user32", "gdi32"])
2020-09-01 20:16:46 +03:00
self._update_extension("PIL._imagingcms", [feature.lcms] + extra)
else:
self._remove_extension("PIL._imagingcms")
2010-11-28 23:15:53 +03:00
2016-03-30 19:16:10 +03:00
if feature.webp:
2014-08-23 04:04:26 +04:00
libs = [feature.webp]
defs = []
if feature.webpmux:
defs.append(("HAVE_WEBPMUX", None))
2014-08-23 04:04:26 +04:00
libs.append(feature.webpmux)
2019-06-13 18:54:57 +03:00
libs.append(feature.webpmux.replace("pmux", "pdemux"))
2020-09-01 20:16:46 +03:00
self._update_extension("PIL._webp", libs, defs)
else:
self._remove_extension("PIL._webp")
2019-06-13 18:54:57 +03:00
tk_libs = ["psapi"] if sys.platform in ("win32", "cygwin") else []
self._update_extension("PIL._imagingtk", tk_libs)
2010-11-28 23:15:53 +03:00
build_ext.build_extensions(self)
#
# sanity checks
2010-11-28 23:15:53 +03:00
self.summary_report(feature)
2010-11-28 23:15:53 +03:00
def summary_report(self, feature):
print("-" * 68)
print("PIL SETUP SUMMARY")
print("-" * 68)
print(f"version Pillow {PILLOW_VERSION}")
v = sys.version.split("[")
print(f"platform {sys.platform} {v[0].strip()}")
2010-11-28 23:15:53 +03:00
for v in v[1:]:
print(f" [{v.strip()}")
print("-" * 68)
2010-11-28 23:15:53 +03:00
raqm_extra_info = ""
if feature.want_vendor("raqm"):
raqm_extra_info += "bundled"
if feature.want_vendor("fribidi"):
raqm_extra_info += ", FriBiDi shim"
2010-11-28 23:15:53 +03:00
options = [
(feature.jpeg, "JPEG"),
2019-06-13 18:54:57 +03:00
(feature.jpeg2000, "OPENJPEG (JPEG2000)", feature.openjpeg_version),
2010-11-28 23:15:53 +03:00
(feature.zlib, "ZLIB (PNG/ZIP)"),
(feature.imagequant, "LIBIMAGEQUANT"),
(feature.tiff, "LIBTIFF"),
2010-11-28 23:15:53 +03:00
(feature.freetype, "FREETYPE2"),
(feature.raqm, "RAQM (Text shaping)", raqm_extra_info),
2013-10-02 10:05:56 +04:00
(feature.lcms, "LITTLECMS2"),
(feature.webp, "WEBP"),
(feature.webpmux, "WEBPMUX"),
2019-09-20 02:14:35 +03:00
(feature.xcb, "XCB (X protocol)"),
]
2010-11-28 23:15:53 +03:00
all = 1
for option in options:
if option[0]:
extra_info = ""
2014-05-31 02:08:21 +04:00
if len(option) >= 3 and option[2]:
extra_info = f" ({option[2]})"
print(f"--- {option[1]} support available{extra_info}")
2010-11-28 23:15:53 +03:00
else:
print(f"*** {option[1]} support not available")
2010-11-28 23:15:53 +03:00
all = 0
print("-" * 68)
2010-11-28 23:15:53 +03:00
if not all:
print("To add a missing option, make sure you have the required")
2016-03-30 19:16:10 +03:00
print("library and headers.")
2019-06-13 18:54:57 +03:00
print(
"See https://pillow.readthedocs.io/en/latest/installation."
"html#building-from-source"
)
2013-03-14 15:07:46 +04:00
print("")
2010-11-28 23:15:53 +03:00
print("To check the build, run the selftest.py script.")
2013-03-14 15:07:46 +04:00
print("")
2010-11-28 23:15:53 +03:00
2014-06-27 19:57:49 +04:00
def debug_build():
return hasattr(sys, "gettotalrefcount") or FUZZING_BUILD
2020-09-01 20:16:46 +03:00
files = ["src/_imaging.c"]
for src_file in _IMAGING:
files.append("src/" + src_file + ".c")
for src_file in _LIB_IMAGING:
files.append(os.path.join("src/libImaging", src_file + ".c"))
ext_modules = [
Extension("PIL._imaging", files),
Extension("PIL._imagingft", ["src/_imagingft.c"]),
2020-09-01 20:16:46 +03:00
Extension("PIL._imagingcms", ["src/_imagingcms.c"]),
Extension("PIL._webp", ["src/_webp.c"]),
Extension("PIL._imagingtk", ["src/_imagingtk.c", "src/Tk/tkImaging.c"]),
Extension("PIL._imagingmath", ["src/_imagingmath.c"]),
Extension("PIL._imagingmorph", ["src/_imagingmorph.c"]),
]
try:
2019-06-13 18:54:57 +03:00
setup(
cmdclass={"build_ext": pil_build_ext},
2020-09-01 20:16:46 +03:00
ext_modules=ext_modules,
2019-06-13 18:54:57 +03:00
zip_safe=not (debug_build() or PLATFORM_MINGW),
)
except RequiredDependencyException as err:
msg = f"""
The headers or library files could not be found for {str(err)},
a required dependency when compiling Pillow from source.
Please see the install instructions at:
2017-02-14 12:27:02 +03:00
https://pillow.readthedocs.io/en/latest/installation.html
"""
sys.stderr.write(msg)
raise RequiredDependencyException(msg)
except DependencyException as err:
msg = f"""
The headers or library files could not be found for {str(err)},
which was requested by the option flag --enable-{str(err)}
"""
sys.stderr.write(msg)
raise DependencyException(msg)