1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729
|
# Author: Lisandro Dalcin
# Contact: dalcinl@gmail.com
"""
Support for building mpi4py with distutils/setuptools.
"""
# ruff: noqa: E402
# ruff: noqa: FURB101, FURB103
# ruff: noqa: PTH106, PTH107, PTH109
# ruff: noqa: PTH110, PTH118, PTH119
# ruff: noqa: PTH120, PTH122, PTH123
# ruff: noqa: PTH207
# -----------------------------------------------------------------------------
import contextlib
import glob
import os
import platform
import re
import shlex
import sys
import warnings
from distutils import log, sysconfig
from distutils.file_util import copy_file
from distutils.util import convert_path
# Fix missing variables PyPy's distutils.sysconfig
if hasattr(sys, "pypy_version_info"):
config_vars = sysconfig.get_config_vars()
for name in ("prefix", "exec_prefix"):
if name not in config_vars:
config_vars[name] = os.path.normpath(getattr(sys, name))
if sys.platform == "darwin" and "LDSHARED" in config_vars:
ldshared = shlex.split(config_vars["LDSHARED"])
while "-shared" in ldshared:
ldshared[ldshared.index("-shared")] = "-bundle"
if "-undefined" not in ldshared:
ldshared.extend("-undefined dynamic_lookup".split())
config_vars["LDSHARED"] = " ".join(ldshared)
# Workaround distutils.cygwinccompiler.get_versions()
# failing when the compiler path contains spaces
from distutils import cygwinccompiler as cygcc
if hasattr(cygcc, "get_versions"):
cygcc_get_versions = cygcc.get_versions
def get_versions():
import distutils.spawn
find_executable_orig = distutils.spawn.find_executable
def find_executable(exe):
exe = find_executable_orig(exe)
if exe and " " in exe:
exe = f'"{exe}"'
return exe
distutils.spawn.find_executable = find_executable
versions = cygcc_get_versions()
distutils.spawn.find_executable = find_executable_orig
return versions
cygcc.get_versions = get_versions
# Workaround distutils.ccompiler.CCompiler._fix_lib_args
from distutils.ccompiler import CCompiler
cc_fix_compile_args_orig = getattr(CCompiler, "_fix_compile_args", None)
cc_fix_lib_args_orig = getattr(CCompiler, "_fix_lib_args", None)
def cc_fix_compile_args(self, out_dir, macros, inc_dirs):
macros = macros or []
inc_dirs = inc_dirs or []
return cc_fix_compile_args_orig(self, out_dir, macros, inc_dirs)
def cc_fix_lib_args(self, libs, lib_dirs, rt_lib_dirs):
libs = libs or []
lib_dirs = lib_dirs or []
rt_lib_dirs = rt_lib_dirs or []
return cc_fix_lib_args_orig(self, libs, lib_dirs, rt_lib_dirs)
CCompiler._fix_compile_args = cc_fix_compile_args
CCompiler._fix_lib_args = cc_fix_lib_args
def _fix_env(cmd, i):
while os.path.basename(cmd[i]) == "env":
i = i + 1
while "=" in cmd[i]:
i = i + 1
return i
def _fix_xcrun(cmd, i):
if os.path.basename(cmd[i]) == "xcrun":
del cmd[i]
while True:
if cmd[i] == "-sdk":
del cmd[i : i + 2]
continue
if cmd[i] == "-log":
del cmd[i]
continue
break
return i
def fix_compiler_cmd(cc, mpicc):
if not mpicc:
return
i = 0
i = _fix_env(cc, i)
i = _fix_xcrun(cc, i)
while os.path.basename(cc[i]) == "ccache":
i = i + 1
cc[i : i + 1] = shlex.split(mpicc)
def fix_linker_cmd(ld, mpild):
if not mpild:
return
i = 0
if (
sys.platform.startswith("aix")
and os.path.basename(ld[i]) == "ld_so_aix"
):
i = 1
i = _fix_env(ld, i)
i = _fix_xcrun(ld, i)
while os.path.basename(ld[i]) == "ccache":
del ld[i]
ld[i : i + 1] = shlex.split(mpild)
def customize_compiler(
compiler,
lang=None,
mpicc=None,
mpicxx=None,
mpild=None,
):
sysconfig.customize_compiler(compiler)
if compiler.compiler_type == "unix":
ld = compiler.linker_exe
for envvar in ("LDFLAGS", "CFLAGS", "CPPFLAGS"):
if envvar in os.environ:
ld += shlex.split(os.environ[envvar])
if os.environ.get("SOURCE_DATE_EPOCH") is not None:
# Linker tweaks for reproducible build
if sys.platform == "darwin":
os.environ["ZERO_AR_DATE"] = "YES"
if compiler.compiler_type == "msvc":
if not compiler.initialized:
compiler.initialize()
for flags in compiler._ldflags.values():
flags.append("/BREPRO")
if compiler.compiler_type == "unix":
# Compiler command overriding
if mpicc:
fix_compiler_cmd(compiler.compiler, mpicc)
if lang in ("c", None):
fix_compiler_cmd(compiler.compiler_so, mpicc)
if mpicxx:
fix_compiler_cmd(compiler.compiler_cxx, mpicxx)
if lang == "c++":
fix_compiler_cmd(compiler.compiler_so, mpicxx)
if mpild:
for ld in [compiler.linker_so, compiler.linker_exe]:
fix_linker_cmd(ld, mpild)
if compiler.compiler_type == "cygwin":
compiler.set_executables(
preprocessor="gcc -mcygwin -E",
)
if compiler.compiler_type == "mingw32":
compiler.set_executables(
preprocessor="gcc -mno-cygwin -E",
)
if compiler.compiler_type in ("unix", "cygwin", "mingw32"):
badcxxflags = ["-Wimplicit", "-Wstrict-prototypes"]
for flag in badcxxflags:
while flag in compiler.compiler_cxx:
compiler.compiler_cxx.remove(flag)
if lang == "c++":
while flag in compiler.compiler_so:
compiler.compiler_so.remove(flag)
if compiler.compiler_type == "mingw32":
# Remove msvcrXX.dll
del compiler.dll_libraries[:]
# https://bugs.python.org/issue12641
if compiler.gcc_version >= "4.4":
for attr in (
"preprocessor",
"compiler",
"compiler_cxx",
"compiler_so",
"linker_so",
"linker_exe",
):
with contextlib.suppress(Exception):
getattr(compiler, attr).remove("-mno-cygwin")
# Add required define and compiler flags for AMD64
if platform.architecture(None)[0] == "64bit":
for attr in (
"preprocessor",
"compiler",
"compiler_cxx",
"compiler_so",
"linker_so",
"linker_exe",
):
getattr(compiler, attr).insert(1, "-DMS_WIN64")
getattr(compiler, attr).insert(1, "-m64")
# -----------------------------------------------------------------------------
from mpiconfig import Config
def configuration(command_obj, verbose=True):
config = Config(log)
config.setup(command_obj)
if verbose:
if config.section and config.filename:
config.log.info(
"MPI configuration: [%s] from '%s'",
config.section,
",".join(config.filename),
)
config.info()
return config
def configure_compiler(compiler, config, lang=None):
#
mpicc = config.get("mpicc")
mpicxx = config.get("mpicxx")
mpild = config.get("mpild")
if not mpild and (mpicc or mpicxx):
if lang == "c":
mpild = mpicc
if lang == "c++":
mpild = mpicxx
if not mpild:
mpild = mpicc or mpicxx
#
customize_compiler(
compiler,
lang,
mpicc=mpicc,
mpicxx=mpicxx,
mpild=mpild,
)
#
for k, v in config.get("define_macros", []):
compiler.define_macro(k, v)
for v in config.get("undef_macros", []):
compiler.undefine_macro(v)
for v in config.get("include_dirs", []):
compiler.add_include_dir(v)
for v in config.get("libraries", []):
compiler.add_library(v)
for v in config.get("library_dirs", []):
compiler.add_library_dir(v)
for v in config.get("runtime_library_dirs", []):
compiler.add_runtime_library_dir(v)
for v in config.get("extra_objects", []):
compiler.add_link_object(v)
if compiler.compiler_type in (
"unix",
"intel",
"cygwin",
"mingw32",
):
cc_args = config.get("extra_compile_args", [])
ld_args = config.get("extra_link_args", [])
compiler.compiler += cc_args
compiler.compiler_so += cc_args
compiler.compiler_cxx += cc_args
compiler.linker_so += ld_args
compiler.linker_exe += ld_args
return compiler
# -----------------------------------------------------------------------------
try:
from mpiapigen import Generator
except ImportError:
class Generator:
def parse_file(self, *args):
raise NotImplementedError("You forgot to grab 'mpiapigen.py'")
@contextlib.contextmanager
def capture_stderr(filename=os.devnull):
stream = sys.stderr
file_obj = None
fno_save = None
try:
file_obj = open(filename, "w")
fno_save = os.dup(stream.fileno())
os.dup2(file_obj.fileno(), stream.fileno())
yield
finally:
if file_obj is not None:
file_obj.close()
if fno_save is not None:
os.dup2(fno_save, stream.fileno())
class ConfigureMPI:
SRCDIR = "src"
SOURCES = [os.path.join("mpi4py", "libmpi.pxd")]
DESTDIR = os.path.join("src", "lib-mpi")
CONFIG_H = "pympiconf.h"
MISSING_H = "missing.h"
CONFIGTEST_H = """\
/* _configtest.h */
#if !defined(MPIAPI)
# define MPIAPI
#endif
"""
def __init__(self, config_cmd):
self.generator = Generator()
for filename in self.SOURCES:
fullname = os.path.join(self.SRCDIR, filename)
self.generator.parse_file(fullname)
self.config_cmd = config_cmd
def run(self):
results = []
with open("_configtest.h", "w") as f:
f.write(self.CONFIGTEST_H)
for node in self.generator:
name = node.name
testcode = node.config()
confcode = node.missing(guard=False)
log.info("checking for '%s'...", name)
ok = self.run_test(testcode)
if not ok:
log.info("**** failed check for '%s'", name)
with open("_configtest.h", "a") as f:
f.write(confcode)
results.append((name, ok))
try:
os.remove("_configtest.h")
except OSError:
pass
return results
def gen_test(self, code):
body = [
'#include "_configtest.h"',
"int main(int argc, char **argv) {",
"\n".join([" " + line for line in code.split("\n")]),
" (void)argc; (void)argv;",
" return 0;",
"}",
]
body = "\n".join(body) + "\n"
return body
def run_test(self, code, lang="c"):
level = log.set_threshold(log.WARN)
log.set_threshold(level)
if not self.config_cmd.noisy:
level = log.set_threshold(log.WARN)
try:
body = self.gen_test(code)
headers = ["stdlib.h", "mpi.h"]
ok = self.config_cmd.try_link(body, headers=headers, lang=lang)
return ok
finally:
log.set_threshold(level)
def dump(self, results):
destdir = self.DESTDIR
config_h = os.path.join(destdir, self.CONFIG_H)
missing_h = os.path.join(destdir, self.MISSING_H)
log.info("writing '%s'", config_h)
self.generator.dump_config_h(config_h, results)
log.info("writing '%s'", missing_h)
self.generator.dump_missing_h(missing_h, None)
# -----------------------------------------------------------------------------
cmd_mpi_opts = [
(
"mpild=",
None,
"MPI linker command, "
"overridden by environment variable 'MPILD' "
"(defaults to 'mpicc' or 'mpicxx' if any is available)",
),
(
"mpicxx=",
None,
"MPI C++ compiler command, "
"overridden by environment variable 'MPICXX' "
"(defaults to 'mpicxx', 'mpiCC', or 'mpic++' if any is available)",
),
(
"mpicc=",
None,
"MPI C compiler command, "
"overridden by environment variables 'MPICC' "
"(defaults to 'mpicc' if available)",
),
(
"mpi=",
None,
"specify a ini-style configuration file and section "
"(e.g. --mpi=filename or --mpi=filename:section), "
"to look for MPI includes/libraries, "
"overridden by environment variable 'MPICFG' "
"(defaults to configuration file 'mpi.cfg' and section 'mpi')",
),
(
"configure",
None,
"exhaustive test for checking missing MPI constants/types/functions",
),
]
def cmd_get_mpi_options(cmd_opts):
optlist = []
for option, _, _ in cmd_opts:
if option[-1] == "=":
option = option[:-1]
option = option.replace("-", "_")
optlist.append(option)
return optlist
def cmd_initialize_mpi_options(cmd):
mpiopts = cmd_get_mpi_options(cmd_mpi_opts)
for op in mpiopts:
setattr(cmd, op, None)
def cmd_set_undefined_mpi_options(cmd, basecmd):
mpiopts = cmd_get_mpi_options(cmd_mpi_opts)
optlist = tuple(zip(mpiopts, mpiopts))
cmd.set_undefined_options(basecmd, *optlist)
# -----------------------------------------------------------------------------
try:
import setuptools
except ImportError:
setuptools = None
def import_command(cmd):
from importlib import import_module
if setuptools:
try:
return import_module("setuptools.command." + cmd)
except ImportError:
pass
return import_module("distutils.command." + cmd)
if setuptools:
from setuptools import (
Command,
Distribution as cls_Distribution,
Extension as cls_Extension,
)
else:
from distutils.core import (
Command,
Distribution as cls_Distribution,
Extension as cls_Extension,
)
cmd_config = import_command("config")
cmd_build = import_command("build")
cmd_install = import_command("install")
cmd_clean = import_command("clean")
cmd_build_ext = import_command("build_ext")
cmd_install_lib = import_command("install_lib")
cmd_install_data = import_command("install_data")
from distutils.errors import (
CCompilerError,
DistutilsError,
DistutilsPlatformError,
DistutilsSetupError,
)
try:
from packaging.version import Version
except ImportError:
try:
from setuptools.extern.packaging.version import Version
except ImportError:
from distutils.version import StrictVersion as Version
try:
from setuptools.modified import newer_group
except ImportError:
try:
from setuptools.dep_util import newer_group
except ImportError:
from distutils.dep_util import newer_group
# -----------------------------------------------------------------------------
# Distribution class supporting a 'executables' keyword
class Distribution(cls_Distribution):
def __init__(self, attrs=None):
# support for pkg data
self.package_data = {}
# PEP 314
self.provides = None
self.requires = None
self.obsoletes = None
# supports 'executables' keyword
self.executables = None
cls_Distribution.__init__(self, attrs)
def has_executables(self):
return self.executables and len(self.executables) > 0
def is_pure(self):
return cls_Distribution.is_pure(self) and not self.has_executables()
# Extension class
class Extension(cls_Extension):
def __init__(self, **kw):
optional = kw.pop("optional", None)
configure = kw.pop("configure", None)
cls_Extension.__init__(self, **kw)
self.optional = optional
self.configure = configure
# Library class
class Library(Extension):
def __init__(self, **kw):
kind = kw.pop("kind", "static")
package = kw.pop("package", None)
dest_dir = kw.pop("dest_dir", None)
Extension.__init__(self, **kw)
self.kind = kind
self.package = package
self.dest_dir = dest_dir
# Executable class
class Executable(Extension):
def __init__(self, **kw):
package = kw.pop("package", None)
dest_dir = kw.pop("dest_dir", None)
Extension.__init__(self, **kw)
self.package = package
self.dest_dir = dest_dir
# setup function
def setup(**attrs):
if setuptools:
from setuptools import setup as fcn_setup
else:
from distutils.core import setup as fcn_setup
if "distclass" not in attrs:
attrs["distclass"] = Distribution
if "cmdclass" not in attrs:
attrs["cmdclass"] = {}
cmdclass = attrs["cmdclass"]
for cmd in (
config,
build,
install,
clean,
build_src,
build_ext,
build_exe,
install_lib,
install_data,
install_exe,
):
if cmd.__name__ not in cmdclass:
cmdclass[cmd.__name__] = cmd
return fcn_setup(**attrs)
# --------------------------------------------------------------------
def with_coverage():
return bool(os.environ.get("MPI4PY_COVERAGE_PLUGIN"))
# --------------------------------------------------------------------
# Cython
def cython_req():
confdir = os.path.dirname(__file__)
basename = "requirements-build-cython.txt"
with open(os.path.join(confdir, basename)) as f:
m = re.search(r"cython\s*>?=+\s*(.*)", f.read().strip())
cython_version = m.groups()[0]
return cython_version
def cython_chk(VERSION, verbose=True):
#
def warn(message):
if not verbose:
return
ruler, ws, nl = "*" * 80, " ", "\n"
pyexe = sys.executable
advise = f"$ {pyexe} -m pip install --upgrade cython"
def printer(*s):
print(*s, file=sys.stderr)
printer(ruler, nl)
printer(ws, message, nl)
printer(ws, ws, advise, nl)
printer(ruler)
#
try:
import Cython
except ImportError:
warn("You need Cython to generate C source files.")
return False
#
CYTHON_VERSION = Cython.__version__
m = re.match(r"(\d+\.\d+(?:\.\d+)?).*", CYTHON_VERSION)
if not m:
warn(f"Cannot parse Cython version string {CYTHON_VERSION!r}")
return False
REQUIRED = Version(VERSION)
PROVIDED = Version(m.groups()[0])
if PROVIDED < REQUIRED:
warn(f"You need Cython >= {VERSION} (you have {CYTHON_VERSION})")
return False
#
if verbose:
log.info("using Cython %s", CYTHON_VERSION)
return True
def cython_run(
source,
target=None,
depends=(),
includes=(),
workdir=None,
force=False,
VERSION="0.0",
):
if target is None:
target = os.path.splitext(source)[0] + ".c"
cwd = os.getcwd()
try:
if workdir:
os.chdir(workdir)
alldeps = [source]
for dep in depends:
alldeps += glob.glob(dep)
if not (force or newer_group(alldeps, target, "newer")):
log.debug("skipping '%s' -> '%s' (up-to-date)", source, target)
return
finally:
os.chdir(cwd)
require = f"Cython >= {VERSION}"
if not cython_chk(VERSION, verbose=False) and setuptools:
if sys.modules.get("Cython"):
removed = getattr(sys.modules["Cython"], "__version__", "")
log.info("removing Cython %s from sys.modules", removed)
pkgname = re.compile(r"cython(\.|$)", re.IGNORECASE)
for modname in list(sys.modules.keys()):
if pkgname.match(modname):
del sys.modules[modname]
try:
install_setup_requires = setuptools._install_setup_requires
with warnings.catch_warnings():
category = setuptools.SetuptoolsDeprecationWarning
warnings.simplefilter("ignore", category)
log.info("fetching build requirement '%s'", require)
install_setup_requires({"setup_requires": [require]})
except Exception:
log.info("failed to fetch build requirement '%s'", require)
if not cython_chk(VERSION):
raise DistutilsError(f"missing build requirement {require!r}")
#
log.info("cythonizing '%s' -> '%s'", source, target)
from cythonize import cythonize
args = []
if with_coverage():
args += ["-X", "linetrace=True"]
if includes:
args += [f"-I{incdir}" for incdir in includes]
if workdir:
args += ["--working", workdir]
args += [source]
if target:
args += ["--output-file", target]
err = cythonize(args)
if err:
raise DistutilsError(f"Cython failure: {source!r} -> {target!r}")
# -----------------------------------------------------------------------------
# A minimalistic MPI program :-)
ConfigTest = """\
int main(int argc, char **argv)
{
int ierr;
(void)argc; (void)argv;
ierr = MPI_Init(&argc, &argv);
if (ierr) return -1;
ierr = MPI_Finalize();
if (ierr) return -1;
return 0;
}
"""
class config(cmd_config.config):
user_options = cmd_config.config.user_options + cmd_mpi_opts
def initialize_options(self):
cmd_config.config.initialize_options(self)
cmd_initialize_mpi_options(self)
self.noisy = 0
def finalize_options(self):
cmd_config.config.finalize_options(self)
if not self.noisy:
self.dump_source = 0
def _clean(self, *a, **kw):
if sys.platform.startswith("win"):
for fn in ("_configtest.exe.manifest",):
if os.path.exists(fn):
self.temp_files.append(fn)
cmd_config.config._clean(self, *a, **kw)
def check_header(
self,
header,
headers=None,
include_dirs=None,
):
if headers is None:
headers = []
log.info("checking for header '%s' ...", header)
body = "int main(int n, char**v) { (void)n; (void)v; return 0; }"
ok = self.try_compile(body, [*headers, header], include_dirs)
log.info("success!" if ok else "failure.")
return ok
def check_macro(
self,
macro,
headers=None,
include_dirs=None,
):
log.info("checking for macro '%s' ...", macro)
body = [
f"#ifndef {macro}",
f"#error macro '{macro}' not defined",
r"#endif",
r"int main(int n, char**v) { (void)n; (void)v; return 0; }",
]
body = "\n".join(body) + "\n"
ok = self.try_compile(body, headers, include_dirs)
return ok
def check_library(
self,
library,
library_dirs=None,
headers=None,
include_dirs=None,
other_libraries=(),
lang="c",
):
if sys.platform == "darwin":
self.compiler.linker_exe.append("-flat_namespace")
self.compiler.linker_exe.append("-undefined")
self.compiler.linker_exe.append("suppress")
log.info("checking for library '%s' ...", library)
body = "int main(int n, char**v) { (void)n; (void)v; return 0; }"
ok = self.try_link(
body,
headers,
include_dirs,
[library, *other_libraries],
library_dirs,
lang=lang,
)
if sys.platform == "darwin":
self.compiler.linker_exe.remove("-flat_namespace")
self.compiler.linker_exe.remove("-undefined")
self.compiler.linker_exe.remove("suppress")
return ok
def check_function(
self,
function,
headers=None,
include_dirs=None,
libraries=None,
library_dirs=None,
decl=0,
call=0,
lang="c",
):
log.info("checking for function '%s' ...", function)
body = []
if decl:
if call:
proto = f"int {function} (void);"
else:
proto = f"int {function};"
if lang == "c":
proto = "\n".join([
"#ifdef __cplusplus",
'extern "C"',
"#endif",
proto,
])
body.append(proto)
body.append(r"int main (int n, char**v) {")
if call:
body.append(f" (void){function}();")
else:
body.append(f" {function};")
body.extend((r" (void)n; (void)v;", r" return 0;", r"}"))
body = "\n".join(body) + "\n"
ok = self.try_link(
body,
headers,
include_dirs,
libraries,
library_dirs,
lang=lang,
)
return ok
def check_symbol(
self,
symbol,
type="int", # noqa: A002
headers=None,
include_dirs=None,
libraries=None,
library_dirs=None,
decl=0,
lang="c",
):
log.info("checking for symbol '%s' ...", symbol)
body = []
if decl:
body.append(f"{type} {symbol};")
body.extend((
r"int main (int n, char**v) {",
f" {type} s; s = {symbol}; (void)s;",
r" (void)n; (void)v;",
r" return 0;",
r"}",
))
body = "\n".join(body) + "\n"
ok = self.try_link(
body,
headers,
include_dirs,
libraries,
library_dirs,
lang=lang,
)
return ok
def check_function_call(
self,
function,
args="",
headers=None,
include_dirs=None,
libraries=None,
library_dirs=None,
lang="c",
):
log.info("checking for function '%s' ...", function)
body = []
body.extend((
r"int main (int n, char**v) {",
f" (void){function}({args});",
r" (void)n; (void)v;",
r" return 0;",
r"}",
))
body = "\n".join(body) + "\n"
ok = self.try_link(
body,
headers,
include_dirs,
libraries,
library_dirs,
lang=lang,
)
return ok
def run(self):
config = configuration(self, verbose=True)
# test MPI C compiler
self.compiler = getattr(self.compiler, "compiler_type", self.compiler)
self._check_compiler()
configure_compiler(self.compiler, config, lang="c")
self.try_link(ConfigTest, headers=["mpi.h"], lang="c")
# test MPI C++ compiler
self.compiler = getattr(self.compiler, "compiler_type", self.compiler)
self._check_compiler()
configure_compiler(self.compiler, config, lang="c++")
self.try_link(ConfigTest, headers=["mpi.h"], lang="c++")
def configure_dl(ext, config_cmd):
log.info("checking for dlopen() availability ...")
dlfcn = config_cmd.check_header("dlfcn.h")
libdl = config_cmd.check_library("dl")
libs = ["dl"] if libdl else None
dlopen = config_cmd.check_function(
"dlopen", libraries=libs, decl=1, call=1
)
if dlfcn:
ext.define_macros += [("HAVE_DLFCN_H", 1)]
if dlopen:
ext.define_macros += [("HAVE_DLOPEN", 1)]
def configure_mpi(ext, config_cmd):
from textwrap import dedent
headers = ["stdlib.h", "mpi.h"]
#
log.info("checking for MPI compile and link ...")
ConfigTest = dedent("""\
int main(int argc, char **argv)
{
(void)MPI_Init(&argc, &argv);
(void)MPI_Finalize();
return 0;
}
""")
errmsg = [
"Cannot {} MPI programs. Check your configuration!!!",
"Installing mpi4py requires a working MPI implementation.",
]
if sys.platform == "linux":
errmsg += [
"If you are running on a supercomputer or cluster, check with",
"the system administrator or refer to the system user guide.",
"Otherwise, if you are running on a laptop or desktop computer,",
"your may be missing the MPICH or Open MPI development package:",
"* On Fedora/RHEL systems, run:",
" $ sudo dnf install mpich-devel # for MPICH",
" $ sudo dnf install openmpi-devel # for Open MPI",
"* On Debian/Ubuntu systems, run:",
" $ sudo apt install libmpich-dev # for MPICH",
" $ sudo apt install libopenmpi-dev # for Open MPI",
]
if sys.platform == "darwin":
errmsg += [
"Install MPICH or Open MPI with Homebrew or MacPorts:"
" $ brew install mpich|openmpi # Homebrew",
" $ port install mpich|openmpi # MacPorts",
]
if sys.platform == "win32":
errmsg += ["Please install *Intel MPI* or *Microsoft MPI*."]
ok = config_cmd.try_compile(ConfigTest, headers=headers)
if not ok:
message = "\n".join(errmsg).format("compile")
raise DistutilsPlatformError(message)
ok = config_cmd.try_link(ConfigTest, headers=headers)
if not ok:
message = errmsg[0].format("link")
raise DistutilsPlatformError(message)
#
impls = ("OPEN_MPI", "MSMPI_VER")
tests = [f"defined({macro})" for macro in impls]
tests += ["(defined(MPICH_NAME)&&(MPICH_NAME>=3))"]
tests += ["(defined(MPICH_NAME)&&(MPICH_NAME==2))"]
tests = "||".join(tests)
ConfigTestAPI = dedent(f"""\
#if !({tests})
#error "Unknown MPI implementation"
#endif
""")
ConfigTestABI = dedent("""\
#if !(defined(MPI_ABI_VERSION)&&(MPI_ABI_VERSION>=1))
#error "MPI ABI not supported"
#endif
""")
with capture_stderr():
log.info("checking for MPI ABI support ...")
mpiabi = config_cmd.try_compile(ConfigTestABI, headers=headers)
config = os.environ.get("MPI4PY_BUILD_CONFIGURE") or None
config = getattr(config_cmd, "configure", None) or config
if not mpiabi and not config:
with capture_stderr():
ok = config_cmd.try_compile(ConfigTestAPI, headers=headers)
config = not ok
if config:
guard = "HAVE_PYMPICONF_H"
with capture_stderr():
ok = config_cmd.check_macro(guard)
config = not ok
if config:
log.info("checking for missing MPI functions/symbols ...")
configure = ConfigureMPI(config_cmd)
with capture_stderr():
results = configure.run()
configure.dump(results)
ext.define_macros += [(guard, 1)]
elif not mpiabi:
log.info("checking for missing MPI functions/symbols ...")
for function, arglist in (
("MPI_Type_create_f90_integer", "0,(MPI_Datatype*)0"),
("MPI_Type_create_f90_real", "0,0,(MPI_Datatype*)0"),
("MPI_Type_create_f90_complex", "0,0,(MPI_Datatype*)0"),
("MPI_Status_c2f", "(MPI_Status*)0,(MPI_Fint*)0"),
("MPI_Status_f2c", "(MPI_Fint*)0,(MPI_Status*)0"),
):
with capture_stderr():
ok = config_cmd.check_function_call(
function, arglist, headers=headers
)
if not ok:
macro = "PyMPI_MISSING_" + function
ext.define_macros += [(macro, 1)]
#
if not mpiabi and os.name == "posix":
configure_dl(ext, config_cmd)
def configure_pyexe(exe, _config_cmd):
if sys.platform.startswith("win"):
return
if sys.platform == "darwin" and (
"Anaconda" in sys.version or "Continuum Analytics" in sys.version
):
py_version = sysconfig.get_python_version()
py_abiflags = getattr(sys, "abiflags", "")
exe.libraries += ["python" + py_version + py_abiflags]
return
#
cfg_vars = sysconfig.get_config_vars()
py_version = sysconfig.get_python_version()
py_abiflags = getattr(sys, "abiflags", "")
libraries = ["python" + py_version + py_abiflags]
if hasattr(sys, "pypy_version_info"):
py_tag = py_version[0].replace("2", "")
libraries = [f"pypy{py_tag}-c"]
if sys.platform == "darwin":
fwkdir = cfg_vars.get("PYTHONFRAMEWORKDIR")
if (
fwkdir
and fwkdir != "no-framework"
and fwkdir in cfg_vars.get("LINKFORSHARED", "")
):
del libraries[:]
#
py_enable_shared = cfg_vars.get("Py_ENABLE_SHARED")
libdir = shlex.split(cfg_vars.get("LIBDIR", ""))
libpl = shlex.split(cfg_vars.get("LIBPL", ""))
library_dirs = []
runtime_dirs = []
if py_enable_shared:
library_dirs += libdir
if sys.exec_prefix != "/usr":
runtime_dirs += libdir
else:
library_dirs += libdir
library_dirs += libpl
#
link_args = []
for var in ("LIBS", "MODLIBS", "SYSLIBS", "LDLAST"):
link_args += shlex.split(cfg_vars.get(var, ""))
#
exe.libraries += libraries
exe.library_dirs += library_dirs
exe.runtime_library_dirs += runtime_dirs
exe.extra_link_args += link_args
class build(cmd_build.build):
user_options = cmd_build.build.user_options + cmd_mpi_opts
boolean_options = cmd_build.build.boolean_options
user_options += [
(
"inplace",
"i",
"ignore build-lib and put compiled extensions into the source "
"directory alongside your pure Python modules",
)
]
boolean_options += ["inplace"]
def initialize_options(self):
cmd_build.build.initialize_options(self)
cmd_initialize_mpi_options(self)
self.inplace = None
def finalize_options(self):
cmd_build.build.finalize_options(self)
config_cmd = self.get_finalized_command("config")
if isinstance(config_cmd, config):
cmd_set_undefined_mpi_options(self, "config")
if self.inplace is None:
self.inplace = False
def has_executables(self):
return self.distribution.has_executables()
sub_commands = [
("build_src", lambda *_: True),
*cmd_build.build.sub_commands,
("build_exe", has_executables),
]
# NOTE: disable build_exe subcommand !!!
del sub_commands[-1]
class build_src(Command):
description = "build C sources from Cython files"
user_options = [
("force", "f", "forcibly build everything (ignore file timestamps)"),
]
boolean_options = ["force"]
def initialize_options(self):
self.force = False
def finalize_options(self):
self.set_undefined_options(
"build",
("force", "force"),
)
def run(self):
sources = getattr(self, "sources", [])
require = cython_req()
for source in sources:
cython_run(
**source,
force=self.force,
VERSION=require,
)
class build_ext(cmd_build_ext.build_ext):
user_options = cmd_build_ext.build_ext.user_options + cmd_mpi_opts
def initialize_options(self):
cmd_build_ext.build_ext.initialize_options(self)
cmd_initialize_mpi_options(self)
self.inplace = None
def finalize_options(self):
self.set_undefined_options("build", ("inplace", "inplace"))
cmd_build_ext.build_ext.finalize_options(self)
build_cmd = self.get_finalized_command("build")
if isinstance(build_cmd, build):
cmd_set_undefined_mpi_options(self, "build")
def run(self):
self.build_sources()
cmd_build_ext.build_ext.run(self)
def build_sources(self):
if self.get_command_name() == "build_ext":
if "build_src" in self.distribution.cmdclass:
self.run_command("build_src")
def build_extensions(self):
# First, sanity-check the 'extensions' list
self.check_extensions_list(self.extensions)
# parse configuration file and configure compiler
self.config = configuration(self, verbose=True)
configure_compiler(self.compiler, self.config)
# build extensions
for ext in self.extensions:
try:
self.build_extension(ext)
except (DistutilsError, CCompilerError):
if not ext.optional:
raise
e = sys.exc_info()[1]
self.warn(f"{e}")
exe = isinstance(ext, Executable)
knd = "executable" if exe else "extension"
self.warn(f'building optional {knd} "{ext.name}" failed')
def config_extension(self, ext):
configure = getattr(ext, "configure", None)
if configure:
config_cmd = self.get_finalized_command("config")
config_cmd.compiler = self.compiler # fix compiler
config_cmd.configure = self.configure
configure(ext, config_cmd)
if with_coverage():
ext.define_macros += [
("CYTHON_TRACE_NOGIL", 1),
("CYTHON_USE_SYS_MONITORING", 0),
]
def _get_pth_files(self, ext):
if ext.name == "mpi4py.MPI" and sys.platform == "win32":
confdir = os.path.dirname(__file__)
topdir = os.path.dirname(confdir)
srcdir = os.path.join(topdir, "src")
dstdir = self.build_lib
for pthfile in ("_mpi_dll_path.py", "mpi.pth"):
source = os.path.join(srcdir, pthfile)
target = os.path.join(dstdir, pthfile)
if os.path.exists(source):
yield (source, target)
def build_extension(self, ext):
fullname = self.get_ext_fullname(ext.name)
filename = os.path.join(
self.build_lib, self.get_ext_filename(fullname)
)
depends = ext.sources + ext.depends
if not (self.force or newer_group(depends, filename, "newer")):
log.debug("skipping '%s' extension (up-to-date)", ext.name)
return
#
self.config_extension(ext)
cmd_build_ext.build_ext.build_extension(self, ext)
#
for source, target in self._get_pth_files(ext):
log.info("writing %s", target)
copy_file(source, target, verbose=False, dry_run=self.dry_run)
def get_outputs(self):
outputs = cmd_build_ext.build_ext.get_outputs(self)
for ext in self.extensions:
for _, target in self._get_pth_files(ext):
outputs.append(target)
return outputs
# Command class to build executables
class build_exe(build_ext):
description = "build binary executable components"
user_options = [
("build-exe=", None, "build directory for executable components"),
*build_ext.user_options,
]
def initialize_options(self):
build_ext.initialize_options(self)
self.build_base = None
self.build_exe = None
self.inplace = None
def finalize_options(self):
build_ext.finalize_options(self)
self.configure = None
self.set_undefined_options(
"build", ("build_base", "build_base"), ("build_lib", "build_exe")
)
self.set_undefined_options("build_ext", ("inplace", "inplace"))
self.executables = self.distribution.executables
# NOTE: This is a hack
self.extensions = self.distribution.executables
self.get_ext_filename = self.get_exe_filename
self.check_extensions_list = self.check_executables_list
self.build_extension = self.build_executable
self.copy_extensions_to_source = self.copy_executables_to_source
self.build_lib = self.build_exe
def get_exe_filename(self, exe_name):
exe_ext = sysconfig.get_config_var("EXE") or ""
return exe_name + exe_ext
def check_executables_list(self, executables):
ListType, TupleType = type([]), type(())
if type(executables) is not ListType:
raise DistutilsSetupError(
"'executables' option must be a list of Executable instances"
)
for exe in executables:
if not isinstance(exe, Executable):
raise DistutilsSetupError(
"'executables' items must be Executable instances"
)
if exe.sources is None or type(exe.sources) not in (
ListType,
TupleType,
):
raise DistutilsSetupError(
f"in 'executables' option (executable '{exe.name}'), "
"'sources' must be present and must be "
"a list of source filenames"
)
def get_exe_fullpath(self, exe, build_dir=None):
build_dir = build_dir or self.build_exe
package_dir = (exe.package or "").split(".")
dest_dir = convert_path(exe.dest_dir or "")
output_dir = os.path.join(build_dir, *[*package_dir, dest_dir])
exe_filename = self.get_exe_filename(exe.name)
return os.path.join(output_dir, exe_filename)
def config_executable(self, exe):
build_ext.config_extension(self, exe)
def build_executable(self, exe):
sources = list(exe.sources)
depends = list(exe.depends)
exe_fullpath = self.get_exe_fullpath(exe)
depends = sources + depends
if not (self.force or newer_group(depends, exe_fullpath, "newer")):
log.debug("skipping '%s' executable (up-to-date)", exe.name)
return
self.config_executable(exe)
log.info("building '%s' executable", exe.name)
# Next, compile the source code to object files.
# Two possible sources for extra compiler arguments:
# - 'extra_compile_args' in Extension object
# - 'define_macros' or 'undef_macros' in Extension object
# - CFLAGS environment variable (not particularly
# elegant, but people seem to expect it and I
# guess it's useful)
# The environment variable should take precedence, and
# any sensible compiler will give precedence to later
# command line args. Hence we combine them in order:
extra_args = exe.extra_compile_args[:]
macros = exe.define_macros[:]
for undef in exe.undef_macros:
macros.append((undef,))
objects = self.compiler.compile(
sources,
output_dir=self.build_temp,
macros=macros,
include_dirs=exe.include_dirs,
debug=self.debug,
extra_postargs=extra_args,
depends=exe.depends,
)
self._built_objects = objects[:]
# Now link the object files together into a "shared object" --
# of course, first we have to figure out all the other things
# that go into the mix.
if exe.extra_objects:
objects.extend(exe.extra_objects)
extra_args = exe.extra_link_args[:]
# Get special linker flags for building a executable with
# bundled Python library, also fix location of needed
# python.exp file on AIX
ldflags = sysconfig.get_config_var("PY_LDFLAGS") or ""
linkshared = sysconfig.get_config_var("LINKFORSHARED") or ""
linkshared = linkshared.replace("-Xlinker ", "-Wl,")
if sys.platform == "darwin": # fix wrong framework paths
fwkprefix = sysconfig.get_config_var("PYTHONFRAMEWORKPREFIX")
fwkdir = sysconfig.get_config_var("PYTHONFRAMEWORKDIR")
if fwkprefix and fwkdir and fwkdir != "no-framework":
for flag in shlex.split(linkshared):
if flag.startswith(fwkdir):
fwkpath = os.path.join(fwkprefix, flag)
linkshared = linkshared.replace(flag, fwkpath)
if sys.platform.startswith("aix"):
python_lib = sysconfig.get_python_lib(standard_lib=1)
python_exp = os.path.join(python_lib, "config", "python.exp")
linkshared = linkshared.replace("Modules/python.exp", python_exp)
# Detect target language, if not provided
language = exe.language or self.compiler.detect_language(sources)
self.compiler.link(
self.compiler.EXECUTABLE,
objects,
exe_fullpath,
output_dir=None,
libraries=self.get_libraries(exe),
library_dirs=exe.library_dirs,
runtime_library_dirs=exe.runtime_library_dirs,
extra_preargs=shlex.split(ldflags) + shlex.split(linkshared),
extra_postargs=extra_args,
debug=self.debug,
target_lang=language,
)
def copy_executables_to_source(self):
build_py = self.get_finalized_command("build_py")
root_dir = build_py.get_package_dir("")
for exe in self.executables:
src = self.get_exe_fullpath(exe)
dest = self.get_exe_fullpath(exe, root_dir)
self.mkpath(os.path.dirname(dest))
copy_file(src, dest, verbose=self.verbose, dry_run=self.dry_run)
def get_outputs(self):
outputs = []
for exe in self.executables:
outputs.append(self.get_exe_fullpath(exe))
return outputs
class install(cmd_install.install):
def initialize_options(self):
with warnings.catch_warnings():
if setuptools:
category = setuptools.SetuptoolsDeprecationWarning
warnings.simplefilter("ignore", category)
cmd_install.install.initialize_options(self)
self.old_and_unmanageable = True
def run(self):
cmd_install.install.run(self)
def has_lib(self):
return cmd_install.install.has_lib(self) and self.has_exe()
def has_exe(self):
return self.distribution.has_executables()
sub_commands = [
*cmd_install.install.sub_commands,
("install_exe", has_exe),
]
# NOTE: disable install_exe subcommand !!!
del sub_commands[-1]
class install_lib(cmd_install_lib.install_lib):
def get_outputs(self):
outputs = cmd_install_lib.install_lib.get_outputs(self)
for build_cmd, build_dir in (("build_exe", "build_exe"),):
cmd_obj = self.get_finalized_command(build_cmd)
build_files = cmd_obj.get_outputs()
exe_outputs = self._mutate_outputs(
self.distribution.has_executables(),
build_cmd,
build_dir,
self.install_dir,
)
for src, dest in zip(build_files, exe_outputs):
if os.path.exists(src):
outputs.append(dest)
return outputs
class install_data(cmd_install_data.install_data):
def finalize_options(self):
self.set_undefined_options(
"install",
("install_lib", "install_dir"),
("root", "root"),
("force", "force"),
)
class install_exe(cmd_install_lib.install_lib):
description = "install binary executable components"
user_options = [
("install-dir=", "d", "directory to install to"),
("build-dir=", "b", "build directory (where to install from)"),
("force", "f", "force installation (overwrite existing files)"),
("skip-build", None, "skip the build steps"),
]
boolean_options = ["force", "skip-build"]
negative_opt = {}
def initialize_options(self):
self.install_dir = None
self.build_dir = None
self.force = 0
self.skip_build = None
def finalize_options(self):
self.set_undefined_options("build_exe", ("build_exe", "build_dir"))
self.set_undefined_options(
"install",
("force", "force"),
("skip_build", "skip_build"),
("install_scripts", "install_dir"),
)
def run(self):
self.build()
self.install()
def build(self):
if not self.skip_build:
if self.distribution.has_executables():
self.run_command("build_exe")
def install(self):
self.outfiles = []
if self.distribution.has_executables():
build_exe = self.get_finalized_command("build_exe")
for exe in build_exe.executables:
exe_fullpath = build_exe.get_exe_fullpath(exe)
exe_filename = os.path.basename(exe_fullpath)
if exe_filename.startswith("python-") and os.name == "posix":
x, y = sys.version_info[:2]
install_name = exe_filename.replace(
"python-", f"python{x}.{y}-"
)
link = None
else:
install_name = exe_filename
link = None
source = exe_fullpath
target = os.path.join(self.install_dir, install_name)
self.mkpath(self.install_dir)
out, _done = self.copy_file(source, target, link=link)
self.outfiles.append(out)
def get_outputs(self):
return self.outfiles
def get_inputs(self):
inputs = []
if self.distribution.has_executables():
build_exe = self.get_finalized_command("build_exe")
inputs.extend(build_exe.get_outputs())
return inputs
class clean(cmd_clean.clean):
description = "clean up temporary files from 'build' command"
user_options = [
*cmd_clean.clean.user_options[:2],
(
"build-exe=",
None,
(
"build directory for executable components "
"[default: 'build_exe.build-exe']"
),
),
*cmd_clean.clean.user_options[2:],
]
def initialize_options(self):
cmd_clean.clean.initialize_options(self)
self.build_exe = None
def finalize_options(self):
cmd_clean.clean.finalize_options(self)
self.set_undefined_options("build_exe", ("build_exe", "build_exe"))
def run(self):
from distutils.dir_util import remove_tree
# remove the build/temp.<plat> directory
# (unless it's already gone)
if os.path.exists(self.build_temp):
remove_tree(self.build_temp, dry_run=self.dry_run)
else:
log.debug("'%s' does not exist -- can't clean it", self.build_temp)
if self.all:
# remove build directories
for directory in (
self.build_lib,
self.build_exe,
self.build_scripts,
self.bdist_base,
):
if os.path.exists(directory):
remove_tree(directory, dry_run=self.dry_run)
else:
log.debug(
"'%s' does not exist -- can't clean it", directory
)
# just for the heck of it, try to remove the base build directory:
# we might have emptied it right now, but if not we don't care
if not self.dry_run:
try:
os.rmdir(self.build_base)
log.info("removing '%s'", self.build_base)
except OSError:
pass
if self.all:
# remove the <package>.egg_info directory
try:
egg_info = self.get_finalized_command("egg_info").egg_info
if os.path.exists(egg_info):
remove_tree(egg_info, dry_run=self.dry_run)
else:
log.debug(
"'%s' does not exist -- can't clean it", egg_info
)
except DistutilsError:
pass
# -----------------------------------------------------------------------------
if setuptools:
with contextlib.suppress(Exception):
from setuptools.command import egg_info as mod_egg_info
class FileList(mod_egg_info.FileList):
def process_template_line(self, line):
level = log.set_threshold(log.ERROR)
try:
super().process_template_line(line)
finally:
log.set_threshold(level)
mod_egg_info.FileList = FileList
# -----------------------------------------------------------------------------
# Support for Reproducible Builds
# https://reproducible-builds.org/docs/source-date-epoch/
timestamp = os.environ.get("SOURCE_DATE_EPOCH")
if timestamp is not None:
import distutils.archive_util as archive_util
import stat
import tarfile
import time
timestamp = float(max(int(timestamp), 0))
class Time:
@staticmethod
def time():
return timestamp
@staticmethod
def localtime(_=None):
return time.localtime(timestamp)
class TarInfoMode:
def __get__(self, obj, objtype=None):
return obj._mode
def __set__(self, obj, stmd):
ifmt = stat.S_IFMT(stmd)
mode = stat.S_IMODE(stmd) & 0o7755
obj._mode = ifmt | mode
class TarInfoAttr:
def __init__(self, value):
self.value = value
def __get__(self, obj, objtype=None):
return self.value
def __set__(self, obj, value):
pass
class TarInfo(tarfile.TarInfo):
mode = TarInfoMode()
mtime = TarInfoAttr(timestamp)
uid = TarInfoAttr(0)
gid = TarInfoAttr(0)
uname = TarInfoAttr("")
gname = TarInfoAttr("")
def make_tarball(*args, **kwargs):
tarinfo_orig = tarfile.TarFile.tarinfo
try:
tarfile.time = Time()
tarfile.TarFile.tarinfo = TarInfo
return archive_util.make_tarball(*args, **kwargs)
finally:
tarfile.time = time
tarfile.TarFile.tarinfo = tarinfo_orig
archive_util.ARCHIVE_FORMATS["gztar"] = (
make_tarball,
*archive_util.ARCHIVE_FORMATS["gztar"][1:],
)
# -----------------------------------------------------------------------------
|