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 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058
|
# Copyright (c) 2020, Riverbank Computing Limited
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
# This is v2.16 of this boilerplate.
from distutils import sysconfig
import glob
import os
import optparse
import sys
###############################################################################
# You shouldn't need to modify anything above this line.
###############################################################################
class ModuleConfiguration(object):
""" This class encapsulates all the module specific information needed by
the rest of this script to implement a configure.py script for modules that
build on top of PyQt. Functions implemented by the rest of this script
that begin with an underscore are considered internal and shouldn't be
called from here.
"""
# The name of the module as it would be used in an import statement.
name = 'Qwt'
# The descriptive name of the module. This is used in help text and error
# messages.
descriptive_name = "Qwt"
# The version of the module as a string. Set it to None if you don't
# provide version information.
version = '1.02.02'
# The name of the PEP 376 .dist-info directory to be created.
distinfo_name = 'Qwt'
# Set if a configuration script is provided that handles versions of PyQt4
# prior to v4.10 (i.e. versions where the pyqtconfig.py module is
# available). If provided the script must be called configure-old.py and
# be in the same directory as this script.
legacy_configuration_script = False
# The minimum version of SIP that is required. This should be a
# dot-separated string of two or three integers (e.g. '1.0', '4.10.3'). If
# it is None or an empty string then the version is not checked.
minimum_sip_version = '4.19'
# Set if support for C++ exceptions can be disabled.
no_exceptions = True
# The name (without the .pyi extension) of the name of the PEP 484 stub
# file to be generated. If it is None or an empty string then a stub file
# is not generated.
pep484_stub_file = 'Qwt'
# Set if the module supports redefining 'protected' as 'public'.
protected_is_public_is_supported = True
# Set if the module supports PyQt4.
pyqt4_is_supported = True
# Set if the module supports PyQt5.
pyqt5_is_supported = True
# Set if the PyQt5 support is the default. It is ignored unless both
# 'pyqt4_is_supported' and 'pyqt5_is_supported' are set.
pyqt5_is_default = True
# The name (without the .api extension) of the name of the Qwt API
# file to be generated. If it is None or an empty string then an API file
# is not generated.
qwt_api_file = 'Qwt'
# The email address that will be included when an error in the script is
# detected. Leave it blank if you don't want to include an address.
support_email_address = 'gudjon@gudjon.org'
# Set if the user can provide a configuration file. It is normally only
# used if cross-compilation is supported.
user_configuration_file_is_supported = True
# Set if the user is allowed to pass PyQt sip flags on the command line.
# It is normally only used if cross-compilation is supported. It is
# ignored unless at least one of 'pyqt4_is_supported' or
# 'pyqt5_is_supported' is set.
user_pyqt_sip_flags_is_supported = True
@staticmethod
def init_target_configuration(target_configuration):
""" Perform any module specific initialisation of the target
target configuration. Typically this is the initialisation of module
specific attributes. To avoid name clashes attributes should be given
a module specific prefix. target_configuration is the target
configuration.
"""
target_configuration.qwt_version = None
target_configuration.qwt_features_dir = None
target_configuration.qwt_inc_dir = None
target_configuration.qwt_lib_dir = None
target_configuration.qwt_lib = None
target_configuration.qwt_sip_dir = None
@staticmethod
def init_optparser(optparser, target_configuration):
""" Perform any module specific initialisation of the command line
option parser. To avoid name clashes destination attributes should be
given a module specific prefix. optparser is the option parser.
target_configuration is the target configuration.
"""
optparser.add_option('--qwt-incdir', '-n', dest='qwt_inc_dir',
type='string', default=None, action='callback',
callback=optparser_store_abspath_dir, metavar="DIR",
help="the directory containing the Qwt header "
"file directory is DIR [default: QT_INSTALL_HEADERS]")
optparser.add_option('--qwt-featuresdir', dest='qwt_features_dir',
type='string', default=None, action='callback',
callback=optparser_store_abspath_dir, metavar="DIR",
help="the directory containing the qwt.prf features "
"file is DIR [default: "
"QT_INSTALL_PREFIX/mkspecs/features]")
optparser.add_option('--qwt-libdir', '-o', dest='qwt_lib_dir',
type='string', default=None, action='callback',
callback=optparser_store_abspath_dir, metavar="DIR",
help="the directory containing the Qwt library is DIR "
"[default: QT_INSTALL_LIBS]")
optparser.add_option('--qwt-lib', '-l', dest='qwt_lib',
type='string', default=None,
help="the Qwt library "
"[default: qwt]")
optparser.add_option('--qwt-sipdir', '-v', dest='qwt_sip_dir',
type='string', default=None, action='callback',
callback=optparser_store_abspath_dir, metavar="DIR",
help="the Qwt .sip files will be installed in DIR "
"[default: %s]" % target_configuration.pyqt_sip_dir)
optparser.add_option("--no-sip-files", action="store_true",
default=False, dest="qwt_no_sip_files",
help="disable the installation of the .sip files "
"[default: enabled]")
@staticmethod
def apply_options(target_configuration, options):
""" Apply the module specific command line options to the target
configuration. target_configuration is the target configuration.
options are the parsed options.
"""
if options.qwt_features_dir is not None:
target_configuration.qwt_features_dir = options.qwt_features_dir
if options.qwt_inc_dir is not None:
target_configuration.qwt_inc_dir = options.qwt_inc_dir
if options.qwt_lib_dir is not None:
target_configuration.qwt_lib_dir = options.qwt_lib_dir
if options.qwt_lib is not None:
target_configuration.qwt_lib = options.qwt_lib
if options.qwt_sip_dir is not None:
target_configuration.qwt_sip_dir = options.qwt_sip_dir
else:
target_configuration.qwt_sip_dir = target_configuration.pyqt_sip_dir
if options.qwt_no_sip_files:
target_configuration.qwt_sip_dir = ''
@staticmethod
def check_module(target_configuration):
""" Perform any module specific checks now that the target
configuration is complete. target_configuration is the target
configuration.
"""
# Find the Qwt header files.
inc_dir = target_configuration.qwt_inc_dir
if inc_dir is None:
inc_dir = target_configuration.qt_inc_dir
qwtglobal = os.path.join(inc_dir, '', 'qwt_global.h')
if not os.access(qwtglobal, os.F_OK):
error(
"%s could not be found in %s. If "
"Qwt is installed then use the --qwt-incdir "
"argument to explicitly specify the correct "
"directory." %(qwtglobal,inc_dir))
# Get the Qwt version string.
qwt_version = read_define(qwtglobal, 'QWT_VERSION_STR')
if qwt_version is None:
error(
"The Qwt version number could not be determined by "
"reading %s." % qwtglobal)
lib_dir = target_configuration.qwt_lib_dir
if lib_dir is None:
lib_dir = target_configuration.qt_lib_dir
if not glob.glob(os.path.join(lib_dir, '*qwt*')):
error(
"The Qwt library could not be found in %s. If "
"Qwt is installed then use the --qwt-libdir "
"argument to explicitly specify the correct "
"directory." % lib_dir)
# Because we include the Python bindings with the C++ code we can
# reasonably force the same version to be used and not bother about
# versioning in the .sip files.
qv=qwt_version.split('.')
qwt_version_numeric = int(qv[0])*10000 + int(qv[1])*100 + int(qv[2])
mv=ModuleConfiguration.version.split('.')
mod_version_numeric = int(mv[0])*10000 + int(mv[1])*100 + int(mv[2])
if qwt_version_numeric < mod_version_numeric:
error(
"Qwt %s is being used but the Python bindings %s "
"are being built. Please use a newer Qwt "
"version." % (qwt_version, ModuleConfiguration.version))
target_configuration.qwt_version = qwt_version
@staticmethod
def inform_user(target_configuration):
""" Inform the user about module specific configuration information.
target_configuration is the target configuration.
"""
inform("Qwt %s is being used." %
target_configuration.qwt_version)
if target_configuration.qwt_sip_dir != '':
inform("The Qwt .sip files will be installed in %s." %
target_configuration.qwt_sip_dir)
@staticmethod
def pre_code_generation(target_config):
""" Perform any module specific initialisation prior to generating the
code. target_config is the target configuration.
"""
# Nothing to do.
@staticmethod
def get_sip_flags(target_configuration):
""" Return the list of module-specific flags to pass to SIP.
target_configuration is the target configuration.
"""
# Nothing to do.
return []
@staticmethod
def get_sip_file(target_configuration):
""" Return the name of the module's .sip file. target_configuration is
the target configuration.
"""
return 'sip/Qwt_Qt5.sip' if target_configuration.pyqt_package == 'PyQt5' else 'sip/Qwt_Qt4.sip'
@staticmethod
def get_sip_installs(target_configuration):
""" Return a tuple of the installation directory of the module's .sip
files and a sequence of the names of each of the .sip files relative to
the directory containing this configuration script. None is returned
if the module's .sip files are not to be installed.
target_configuration is the target configuration.
"""
if target_configuration.qwt_sip_dir == '':
return None
path = os.path.join(target_configuration.qwt_sip_dir, 'Qwt')
files = glob.glob('sip/*.sip')
return path, files
@staticmethod
def get_qmake_configuration(target_configuration):
""" Return a dict of qmake configuration values for CONFIG, DEFINES,
INCLUDEPATH, LIBS and QT. If value names (i.e. dict keys) have either
'Qt4' or 'Qt5' prefixes then they are specific to the corresponding
version of Qt. target_configuration is the target configuration.
"""
qmake = {'CONFIG': 'qwt'}
if target_configuration.qwt_inc_dir is not None:
qmake['INCLUDEPATH'] = quote(target_configuration.qwt_inc_dir)
if target_configuration.qwt_lib_dir is not None:
qmake['LIBS'] = '-L%s' % quote(target_configuration.qwt_lib_dir)
if target_configuration.qwt_features_dir is not None:
os.environ['QMAKEFEATURES'] = target_configuration.qwt_features_dir
return qmake
@staticmethod
def get_mac_wrapped_library_file(target_configuration):
""" Return the full pathname of the file that implements the library
being wrapped by the module as it would be called on OS/X so that the
module will reference it explicitly without DYLD_LIBRARY_PATH being
set. If it is None or an empty string then the default is used.
target_configuration is the target configuration.
"""
return None
###############################################################################
# You shouldn't need to modify anything below this line.
###############################################################################
def error(msg):
""" Display an error message and terminate. msg is the text of the error
message.
"""
sys.stderr.write(_format("Error: " + msg) + "\n")
sys.exit(1)
def inform(msg):
""" Display an information message. msg is the text of the error message.
"""
sys.stdout.write(_format(msg) + "\n")
def quote(path):
""" Return a path with quotes added if it contains spaces. path is the
path.
"""
if ' ' in path:
path = '"%s"' % path
return path
def optparser_store_abspath(option, opt_str, value, parser):
""" An optparser callback that saves an option as an absolute pathname. """
setattr(parser.values, option.dest, os.path.abspath(value))
def optparser_store_abspath_dir(option, opt_str, value, parser):
""" An optparser callback that saves an option as the absolute pathname
of an existing directory.
"""
if not os.path.isdir(value):
raise optparse.OptionValueError("'%s' is not a directory" % value)
setattr(parser.values, option.dest, os.path.abspath(value))
def optparser_store_abspath_exe(option, opt_str, value, parser):
""" An optparser callback that saves an option as the absolute pathname
of an existing executable.
"""
if not os.access(value, os.X_OK):
raise optparse.OptionValueError("'%s' is not an executable" % value)
setattr(parser.values, option.dest, os.path.abspath(value))
def read_define(filename, define):
""" Read the value of a #define from a file. filename is the name of the
file. define is the name of the #define. None is returned if there was no
such #define.
"""
f = open(filename)
for l in f:
wl = l.split()
if len(wl) >= 3 and wl[0] == "#define" and wl[1] == define:
# Take account of embedded spaces.
value = ' '.join(wl[2:])[1:-1]
break
else:
value = None
f.close()
return value
def version_from_string(version_str):
""" Convert a version string of the form m, m.n or m.n.o to an encoded
version number (or None if it was an invalid format). version_str is the
version string.
"""
parts = version_str.split('.')
if not isinstance(parts, list):
return None
if len(parts) == 1:
parts.append('0')
if len(parts) == 2:
parts.append('0')
if len(parts) != 3:
return None
version = 0
for part in parts:
try:
v = int(part)
except ValueError:
return None
version = (version << 8) + v
return version
def _format(msg, left_margin=0, right_margin=78):
""" Format a message by inserting line breaks at appropriate places. msg
is the text of the message. left_margin is the position of the left
margin. right_margin is the position of the right margin. Returns the
formatted message.
"""
curs = left_margin
fmsg = " " * left_margin
for w in msg.split():
l = len(w)
if curs != left_margin and curs + l > right_margin:
fmsg = fmsg + "\n" + (" " * left_margin)
curs = left_margin
if curs > left_margin:
fmsg = fmsg + " "
curs = curs + 1
fmsg = fmsg + w
curs = curs + l
return fmsg
class _ConfigurationFileParser:
""" A parser for configuration files. """
def __init__(self, config_file):
""" Read and parse a configuration file. """
self._config = {}
self._extrapolating = []
cfg = open(config_file)
line_nr = 0
last_name = None
section = ''
section_config = {}
self._config[section] = section_config
for l in cfg:
line_nr += 1
# Strip comments.
l = l.split('#')[0]
# See if this might be part of a multi-line.
multiline = (last_name is not None and len(l) != 0 and l[0] == ' ')
l = l.strip()
if l == '':
last_name = None
continue
# See if this is a new section.
if l[0] == '[' and l[-1] == ']':
section = l[1:-1].strip()
if section == '':
error(
"%s:%d: Empty section name." % (
config_file, line_nr))
if section in self._config:
error(
"%s:%d: Section '%s' defined more than once." % (
config_file, line_nr, section))
section_config = {}
self._config[section] = section_config
last_name = None
continue
parts = l.split('=', 1)
if len(parts) == 2:
name = parts[0].strip()
value = parts[1].strip()
elif multiline:
name = last_name
value = section_config[last_name]
value += ' ' + l
else:
name = value = ''
if name == '' or value == '':
error("%s:%d: Invalid line." % (config_file, line_nr))
section_config[name] = value
last_name = name
cfg.close()
def sections(self):
""" Return the list of sections, excluding the default one. """
return [s for s in self._config.keys() if s != '']
def preset(self, name, value):
""" Add a preset value to the configuration. """
self._config[''][name] = value
def get(self, section, name, default=None):
""" Get a configuration value while extrapolating. """
# Get the name from the section, or the default section.
value = self._config[section].get(name)
if value is None:
value = self._config[''].get(name)
if value is None:
if default is None:
error(
"Configuration file references non-existent name "
"'%s'." % name)
return default
# Handle any extrapolations.
parts = value.split('%(', 1)
while len(parts) == 2:
prefix, tail = parts
parts = tail.split(')', 1)
if len(parts) != 2:
error(
"Configuration file contains unterminated "
"extrapolated name '%s'." % tail)
xtra_name, suffix = parts
if xtra_name in self._extrapolating:
error(
"Configuration file contains a recursive reference to "
"'%s'." % xtra_name)
self._extrapolating.append(xtra_name)
xtra_value = self.get(section, xtra_name)
self._extrapolating.pop()
value = prefix + xtra_value + suffix
parts = value.split('%(', 1)
return value
def getboolean(self, section, name, default):
""" Get a boolean configuration value while extrapolating. """
value = self.get(section, name, default)
# In case the default was returned.
if isinstance(value, bool):
return value
if value in ('True', 'true', '1'):
return True
if value in ('False', 'false', '0'):
return False
error(
"Configuration file contains invalid boolean value for "
"'%s'." % name)
def getlist(self, section, name, default):
""" Get a list configuration value while extrapolating. """
value = self.get(section, name, default)
# In case the default was returned.
if isinstance(value, list):
return value
return value.split()
class _HostPythonConfiguration:
""" A container for the host Python configuration. """
def __init__(self):
""" Initialise the configuration. """
self.platform = sys.platform
self.version = sys.hexversion >> 8
self.inc_dir = sysconfig.get_python_inc()
self.venv_inc_dir = sysconfig.get_python_inc(prefix=sys.prefix)
self.module_dir = sysconfig.get_python_lib(plat_specific=1)
self.debug = hasattr(sys, 'gettotalrefcount')
if sys.platform == 'win32':
try:
# Python v3.3 and later.
base_prefix = sys.base_prefix
except AttributeError:
try:
# virtualenv for Python v2.
base_prefix = sys.real_prefix
except AttributeError:
# We can't detect the base prefix in Python v3 prior to
# v3.3.
base_prefix = sys.prefix
self.data_dir = sys.prefix
self.lib_dir = base_prefix + '\\libs'
else:
self.data_dir = sys.prefix + '/share'
self.lib_dir = sys.prefix + '/lib'
class _TargetQtConfiguration:
""" A container for the target Qt configuration. """
def __init__(self, qmake):
""" Initialise the configuration. qmake is the full pathname of the
qmake executable that will provide the configuration.
"""
pipe = os.popen(quote(qmake) + ' -query')
for l in pipe:
l = l.strip()
tokens = l.split(':', 1)
if isinstance(tokens, list):
if len(tokens) != 2:
error("Unexpected output from qmake: '%s'\n" % l)
name, value = tokens
else:
name = tokens
value = None
name = name.replace('/', '_')
setattr(self, name, value)
pipe.close()
class _TargetConfiguration:
""" A container for the target configuration. """
def __init__(self, pkg_config):
""" Initialise the configuration with default values. pkg_config is
the package configuration.
"""
# Values based on the host Python configuration.
py_config = _HostPythonConfiguration()
self.py_debug = py_config.debug
self.py_platform = py_config.platform
self.py_version = py_config.version
self.py_module_dir = py_config.module_dir
self.py_inc_dir = py_config.inc_dir
self.py_venv_inc_dir = py_config.venv_inc_dir
self.py_pylib_dir = py_config.lib_dir
self.py_sip_dir = os.path.join(py_config.data_dir, 'sip')
# Remaining values.
self.abi_version = None
self.debug = False
self.pyqt_sip_flags = None
self.pyqt_version_str = ''
self.qmake = self._find_exe('qmake')
self.qmake_spec = ''
self.qmake_variables = []
self.qt_version = 0
self.qt_version_str = ''
self.sip = self._find_exe('sip5', 'sip')
self.sip_inc_dir = None
self.sip_version = None
self.sip_version_str = None
self.sysroot = ''
self.stubs_dir = ''
self.distinfo = False
self.prot_is_public = (self.py_platform.startswith('linux') or self.py_platform == 'darwin')
if pkg_config.pyqt5_is_supported and pkg_config.pyqt4_is_supported:
pyqt = 'PyQt5' if pkg_config.pyqt5_is_default else 'PyQt4'
elif pkg_config.pyqt5_is_supported and not pkg_config.pyqt4_is_supported:
pyqt = 'PyQt5'
elif not pkg_config.pyqt5_is_supported and pkg_config.pyqt4_is_supported:
pyqt = 'PyQt4'
else:
pyqt = None
if pyqt is not None:
self.module_dir = os.path.join(py_config.module_dir, pyqt)
self.pyqt_sip_dir = os.path.join(self.py_sip_dir, pyqt)
else:
self.module_dir = py_config.module_dir
self.pyqt_sip_dir = None
self.pyqt_package = pyqt
pkg_config.init_target_configuration(self)
def update_from_configuration_file(self, config_file):
""" Update the configuration with values from a file. config_file
is the name of the configuration file.
"""
inform("Reading configuration from %s..." % config_file)
parser = _ConfigurationFileParser(config_file)
# Populate some presets from the command line.
parser.preset('py_major', str(self.py_version >> 16))
parser.preset('py_minor', str((self.py_version >> 8) & 0xff))
parser.preset('sysroot', self.sysroot)
if self.pyqt_package is None:
section = ''
else:
# At the moment we only need to distinguish between PyQt4 and
# PyQt5. If that changes we may need a --target-pyqt-version
# command line option.
pyqt_version = 0x050000 if self.pyqt_package == 'PyQt5' else 0x040000
# Find the section corresponding to the version of PyQt.
section = None
latest_section = -1
for name in parser.sections():
parts = name.split()
if len(parts) != 2 or parts[0] != 'PyQt':
continue
section_pyqt_version = version_from_string(parts[1])
if section_pyqt_version is None:
continue
# Major versions must match.
if section_pyqt_version >> 16 != pyqt_version >> 16:
continue
# It must be no later that the version of PyQt.
if section_pyqt_version > pyqt_version:
continue
# Save it if it is the latest so far.
if section_pyqt_version > latest_section:
section = name
latest_section = section_pyqt_version
if section is None:
error(
"%s does not define a section that covers PyQt "
"v%s." % (config_file, self.pyqt_version_str))
self.py_platform = parser.get(section, 'py_platform', self.py_platform)
self.py_inc_dir = parser.get(section, 'py_inc_dir', self.py_inc_dir)
self.py_venv_inc_dir = self.py_inc_dir
self.py_pylib_dir = parser.get(section, 'py_pylib_dir',
self.py_pylib_dir)
self.module_dir = parser.get(section, 'module_dir', self.module_dir)
if self.pyqt_package is not None:
self.py_sip_dir = parser.get(section, 'py_sip_dir',
self.py_sip_dir)
# Construct the SIP flags.
flags = []
sip_module = parser.get(section, 'sip_module')
if sip_module is not None:
flags.append('-n')
flags.append(sip_module)
flags.append('-t')
flags.append(self._get_platform_tag())
if self.pyqt_package == 'PyQt5':
if self.qt_version < 0x050000:
error("PyQt5 requires Qt v5.0 or later.")
if self.qt_version > 0x060000:
self.qt_version = 0x060000
else:
if self.qt_version > 0x050000:
self.qt_version = 0x050000
major = (self.qt_version >> 16) & 0xff
minor = (self.qt_version >> 8) & 0xff
patch = self.qt_version & 0xff
# Qt v5.12.4 was the last release where we updated PyQt for a
# patch version.
if (major, minor) >= (5, 13):
patch = 0
elif (major, minor) == (5, 12):
if patch > 4:
patch = 4
flags.append('-t')
flags.append('Qt_%d_%d_%d' % (major, minor, patch))
for feat in parser.getlist(section, 'pyqt_disabled_features', []):
flags.append('-x')
flags.append(feat)
self.pyqt_sip_flags = ' '.join(flags)
def _get_platform_tag(self):
""" Return the tag for the target platform. """
# This replicates the logic in PyQt's configure scripts.
if self.py_platform == 'win32':
plattag = 'WS_WIN'
elif self.py_platform == 'darwin':
plattag = 'WS_MACX'
else:
plattag = 'WS_X11'
return plattag
def introspect_pyqt(self, pkg_config):
""" Introspect PyQt to determine the sip flags required. pkg_config
is the package configuration.
"""
if self.pyqt_package == 'PyQt5':
try:
from PyQt5 import QtCore
except ImportError:
error(
"Unable to import PyQt5.QtCore. Make sure PyQt5 is "
"installed.")
else:
try:
from PyQt4 import QtCore
except ImportError:
error(
"Unable to import PyQt4.QtCore. Make sure PyQt4 is "
"installed.")
self.pyqt_version_str = QtCore.PYQT_VERSION_STR
self.qt_version_str = QtCore.qVersion()
# See if we have a PyQt that embeds its configuration.
try:
pyqt_config = QtCore.PYQT_CONFIGURATION
except AttributeError:
pyqt_config = None
if pyqt_config is None:
if pkg_config.legacy_configuration_script:
# Fallback to the old configuration script.
config_script = sys.argv[0].replace('configure', 'configure-old')
args = [sys.executable, config_script] + sys.argv[1:]
try:
os.execv(sys.executable, args)
except OSError:
pass
error("Unable to execute '%s'" % config_script)
error("PyQt v4.10 or later is required.")
self.pyqt_sip_flags = pyqt_config['sip_flags']
# This is a hack to remove the -t Qt_5_15_0 which doesn't seem to work with sip5 and > Qt_5_15_0
# There must be a better fix but until then...... XXXXXXXXXXXXXXXX
if self.using_sip5() and self.pyqt_package == 'PyQt5':
for f in pyqt_config['sip_flags'].split():
if len(f) > 6 and f[0:5] == "Qt_5_" and f >= "Qt_5_15_0":
self.pyqt_sip_flags = "-n PyQt5.sip" #pyqt_config['sip_flags']
break
def apply_sysroot(self):
""" Apply sysroot where necessary. """
if self.sysroot != '':
self.py_inc_dir = self._apply_sysroot(self.py_inc_dir)
self.py_venv_inc_dir = self._apply_sysroot(self.py_venv_inc_dir)
self.py_pylib_dir = self._apply_sysroot(self.py_pylib_dir)
self.py_sip_dir = self._apply_sysroot(self.py_sip_dir)
self.module_dir = self._apply_sysroot(self.module_dir)
def _apply_sysroot(self, dir_name):
""" Replace any leading sys.prefix of a directory name with sysroot.
"""
if dir_name.startswith(sys.prefix):
dir_name = self.sysroot + dir_name[len(sys.prefix):]
return dir_name
def get_qt_configuration(self, opts):
""" Get the Qt configuration that can be extracted from qmake. opts
are the command line options.
"""
# Query qmake.
qt_config = _TargetQtConfiguration(self.qmake)
self.qt_version_str = getattr(qt_config, 'QT_VERSION', '')
self.qt_version = version_from_string(self.qt_version_str)
if self.qt_version is None:
error("Unable to determine the version of Qt.")
# On Windows for Qt versions prior to v5.9.0 we need to be explicit
# about the qmake spec.
if self.qt_version < 0x050900 and self.py_platform == 'win32':
if self.py_version >= 0x030500:
self.qmake_spec = 'win32-msvc2015'
elif self.py_version >= 0x030300:
self.qmake_spec = 'win32-msvc2010'
elif self.py_version >= 0x020600:
self.qmake_spec = 'win32-msvc2008'
elif self.py_version >= 0x020400:
self.qmake_spec = 'win32-msvc.net'
else:
self.qmake_spec = 'win32-msvc'
else:
# Otherwise use the default.
self.qmake_spec = ''
# The binary MacOS/X Qt installer used to default to XCode. If so then
# use macx-clang (Qt v5) or macx-g++ (Qt v4).
if sys.platform == 'darwin':
try:
# Qt v5.
if qt_config.QMAKE_SPEC == 'macx-xcode':
# This will exist (and we can't check anyway).
self.qmake_spec = 'macx-clang'
else:
# No need to explicitly name the default.
self.qmake_spec = ''
except AttributeError:
# Qt v4.
self.qmake_spec = 'macx-g++'
self.api_dir = os.path.join(qt_config.QT_INSTALL_DATA, 'qwt')
self.qt_inc_dir = qt_config.QT_INSTALL_HEADERS
self.qt_lib_dir = qt_config.QT_INSTALL_LIBS
if self.sysroot == '':
self.sysroot = getattr(qt_config, 'QT_SYSROOT', '')
def apply_pre_options(self, opts):
""" Apply options from the command line that influence subsequent
configuration. opts are the command line options.
"""
# On Windows the interpreter must be a debug build if a debug version
# is to be built and vice versa.
if sys.platform == 'win32':
if opts.debug:
if not self.py_debug:
error(
"A debug version of Python must be used when "
"--debug is specified.")
elif self.py_debug:
error(
"--debug must be specified when a debug version of "
"Python is used.")
self.debug = opts.debug
# Get the system root.
if opts.sysroot is not None:
self.sysroot = opts.sysroot
# Determine how to run qmake.
if opts.qmake is not None:
self.qmake = opts.qmake
# On Windows add the directory that probably contains the Qt DLLs
# to PATH.
if sys.platform == 'win32':
path = os.environ['PATH']
path = os.path.dirname(self.qmake) + ';' + path
os.environ['PATH'] = path
if self.qmake is None:
error(
"Use the --qmake argument to explicitly specify a working "
"Qt qmake.")
if opts.qmakespec is not None:
self.qmake_spec = opts.qmakespec
if self.pyqt_package is not None:
try:
self.pyqt_package = opts.pyqt_package
except AttributeError:
# Multiple PyQt versions are not supported.
pass
self.module_dir = os.path.join(self.py_module_dir,
self.pyqt_package)
def apply_post_options(self, opts, pkg_config):
""" Apply options from the command line that override the previous
configuration. opts are the command line options. pkg_config is the
package configuration.
"""
if self.pyqt_package is not None:
if pkg_config.user_pyqt_sip_flags_is_supported:
if opts.pyqt_sip_flags is not None:
self.pyqt_sip_flags = opts.pyqt_sip_flags
if opts.pyqt_sip_dir is not None:
self.pyqt_sip_dir = opts.pyqt_sip_dir
else:
# If sip v5 or later installed a bindings directory then assume
# the PyQt .sip files are there.
bindings_dir = os.path.join(self.module_dir, 'bindings')
if os.path.isdir(bindings_dir):
self.pyqt_sip_dir = bindings_dir
else:
self.pyqt_sip_dir = os.path.join(self.py_sip_dir,
self.pyqt_package)
if _has_stubs(pkg_config):
if opts.stubsdir is not None:
self.stubs_dir = opts.stubsdir
if opts.no_stubs:
self.stubs_dir = ''
elif self.stubs_dir == '':
self.stubs_dir = self.module_dir
if pkg_config.qwt_api_file:
if opts.apidir is not None:
self.api_dir = opts.apidir
if opts.no_qwt_api:
self.api_dir = ''
if opts.destdir is not None:
self.module_dir = opts.destdir
if pkg_config.protected_is_public_is_supported:
if opts.prot_is_public is not None:
self.prot_is_public = opts.prot_is_public
else:
self.prot_is_public = False
if opts.sip_inc_dir is not None:
self.sip_inc_dir = opts.sip_inc_dir
if opts.sip is not None:
self.sip = opts.sip
if opts.abi_version is not None:
if not self.using_sip5():
error("The --abi-version argument can only be used with sip5.")
self.abi_version = opts.abi_version
if pkg_config.distinfo_name and opts.distinfo:
self.distinfo = True
pkg_config.apply_options(self, opts)
def using_sip5(self):
""" Return True if sip5 is being used. """
return os.path.basename(self.sip).startswith('sip5')
@staticmethod
def _find_exe(*exes):
""" Find an executable, ie. the first on the path. """
path_dirs = os.environ.get('PATH', '').split(os.pathsep)
for exe in exes:
# Strip any surrounding quotes.
if exe.startswith('"') and exe.endswith('"'):
exe = exe[1:-1]
if sys.platform == 'win32':
exe = exe + '.exe'
for d in path_dirs:
exe_path = os.path.join(d, exe)
if os.access(exe_path, os.X_OK):
return exe_path
return None
def _create_optparser(target_config, pkg_config):
""" Create the parser for the command line. target_config is the target
configuration containing default values. pkg_config is the package
configuration.
"""
pkg_name = pkg_config.descriptive_name
p = optparse.OptionParser(usage="python %prog [options]",
version=pkg_config.version)
p.add_option('--spec', dest='qmakespec', default=None, action='store',
metavar="SPEC",
help="pass -spec SPEC to qmake")
if pkg_config.distinfo_name:
p.add_option("--no-dist-info", action="store_false", default=True,
dest="distinfo",
help="do not install the dist-info directory")
if _has_stubs(pkg_config):
p.add_option('--stubsdir', dest='stubsdir', type='string',
default=None, action='callback',
callback=optparser_store_abspath, metavar="DIR",
help="the PEP 484 stubs will be installed in DIR [default: "
"with the module]")
p.add_option('--no-stubs', dest='no_stubs', default=False,
action='store_true',
help="disable the installation of the PEP 484 stubs "
"[default: enabled]")
if pkg_config.qwt_api_file:
p.add_option('--apidir', '-a', dest='apidir', type='string',
default=None, action='callback',
callback=optparser_store_abspath, metavar="DIR",
help="the Qwt API file will be installed in DIR "
"[default: QT_INSTALL_DATA/qwt]")
p.add_option('--no-qwt-api', dest='no_qwt_api', default=False,
action='store_true',
help="disable the installation of the Qwt API file "
"[default: enabled]")
if pkg_config.user_configuration_file_is_supported:
p.add_option('--configuration', dest='config_file', type='string',
default=None, action='callback',
callback=optparser_store_abspath, metavar="FILE",
help="FILE defines the target configuration")
p.add_option('--destdir', '-d', dest='destdir', type='string',
default=None, action='callback', callback=optparser_store_abspath,
metavar="DIR",
help="install %s in DIR [default: %s]" %
(pkg_name, target_config.module_dir))
if pkg_config.protected_is_public_is_supported:
p.add_option('--protected-is-public', dest='prot_is_public',
default=None, action='store_true',
help="enable building with 'protected' redefined as 'public' "
"[default: %s]" % target_config.prot_is_public)
p.add_option('--protected-not-public', dest='prot_is_public',
action='store_false',
help="disable building with 'protected' redefined as 'public'")
if target_config.pyqt_package is not None:
pyqt = target_config.pyqt_package
if pkg_config.pyqt5_is_supported and pkg_config.pyqt4_is_supported:
p.add_option('--pyqt', dest='pyqt_package', type='choice',
choices=['PyQt4', 'PyQt5'], default=pyqt,
action='store', metavar="PyQtn",
help="configure for PyQt4 or PyQt5 [default: %s]" % pyqt)
if pkg_config.user_pyqt_sip_flags_is_supported:
p.add_option('--pyqt-sip-flags', dest='pyqt_sip_flags',
default=None, action='store', metavar="FLAGS",
help="the sip flags used to build PyQt [default: query PyQt]")
p.add_option('--qmake', '-q', dest='qmake', type='string', default=None,
action='callback', callback=optparser_store_abspath_exe,
metavar="FILE",
help="the pathname of qmake is FILE [default: %s]" % (
target_config.qmake or "search PATH"))
p.add_option('--sip', dest='sip', type='string', default=None,
action='callback', callback=optparser_store_abspath_exe,
metavar="FILE",
help="the pathname of sip is FILE [default: "
"%s]" % (target_config.sip or "None"))
p.add_option('--sip-incdir', dest='sip_inc_dir', type='string',
default=None, action='callback',
callback=optparser_store_abspath_dir, metavar="DIR",
help="the directory containing the sip.h header file file is DIR "
"[default: %s]" % target_config.sip_inc_dir)
p.add_option("--abi-version", dest='abi_version', default=None,
metavar="VERSION",
help="the SIP ABI version to use (sip5 only)")
if target_config.pyqt_package is not None:
p.add_option('--pyqt-sipdir', dest='pyqt_sip_dir', type='string',
default=None, action='callback',
callback=optparser_store_abspath_dir, metavar="DIR",
help="the directory containing the PyQt .sip files is DIR "
"[default: %s]" % target_config.pyqt_sip_dir)
p.add_option('--concatenate', '-c', dest='concat', default=False,
action='store_true',
help="concatenate the C++ source files")
p.add_option('--concatenate-split', '-j', dest='split', type='int',
default=1, metavar="N",
help="split the concatenated C++ source files into N pieces "
"[default: 1]")
p.add_option('--static', '-k', dest='static', default=False,
action='store_true',
help="build a static %s" % pkg_name)
p.add_option("--sysroot", dest='sysroot', type='string', action='callback',
callback=optparser_store_abspath_dir, metavar="DIR",
help="DIR is the target system root directory")
p.add_option('--no-docstrings', dest='no_docstrings', default=False,
action='store_true',
help="disable the generation of docstrings")
p.add_option('--trace', '-r', dest='tracing', default=False,
action='store_true',
help="build %s with tracing enabled" % pkg_name)
p.add_option('--debug', '-u', default=False, action='store_true',
help="build %s with debugging symbols" % pkg_name)
p.add_option('--verbose', '-w', dest='verbose', default=False,
action='store_true',
help="enable verbose output during configuration")
pkg_config.init_optparser(p, target_config)
return p
def _has_stubs(pkg_config):
""" See if a stub file for any of the modules will be generated.
pkg_config is the package configuration.
"""
for module_config in pkg_config.modules:
if module_config.pep484_stub_file:
return True
return False
def _inform_user(target_config, pkg_config):
""" Tell the user the values that are going to be used. target_config is
the target configuration. pkg_config is the package configuration.
"""
pkg_name = pkg_config.descriptive_name
inform("Configuring %s %s..." % (pkg_name, pkg_config.version))
pkg_config.inform_user(target_config)
inform("%s will be installed in %s." %
(pkg_name, target_config.module_dir))
if target_config.debug:
inform("A debug version of %s will be built." % pkg_name)
if target_config.py_debug:
inform("A debug build of Python is being used.")
if target_config.pyqt_version_str != '':
inform("PyQt %s is being used." % target_config.pyqt_version_str)
else:
inform("%s is being used." % target_config.pyqt_package)
if target_config.qt_version_str != '':
inform("Qt %s is being used." % target_config.qt_version_str)
if target_config.sysroot != '':
inform("The system root directory is %s." % target_config.sysroot)
inform("sip %s is being used." % target_config.sip_version_str)
inform("The sip executable is %s." % target_config.sip)
if target_config.prot_is_public:
inform("%s is being built with 'protected' redefined as 'public'." %
pkg_name)
if target_config.stubs_dir != '':
inform("The PEP 484 stubs will be installed in %s." %
target_config.stubs_dir)
if pkg_config.qwt_api_file and target_config.api_dir != '':
inform("The Qwt API file will be installed in %s." %
os.path.join(target_config.api_dir, 'api', 'python'))
def _generate_code(target_config, opts, pkg_config, module_config, all_installs):
""" Generate the code for the module. target_config is the target
configuration. opts are the command line options. pkg_config is the
package configuration. module_config is the module configuration.
all_installs is a list that is updated with the files installed for this
module.
"""
inform(
"Generating the C++ source for the %s module..." %
module_config.name)
# Generate the code in a module-specific sub-directory.
try:
os.mkdir(module_config.name)
except:
pass
# Build the SIP command line.
argv = [quote(target_config.sip)]
if target_config.abi_version:
argv.append('--abi-version')
argv.append(target_config.abi_version)
# Tell SIP if this is a debug build of Python (SIP v4.19.1 and later).
if target_config.sip_version >= 0x041301 and target_config.py_debug:
argv.append('-D')
# This assumes that, for multi-module packages, each modules' .sip files
# will be rooted in a common root directory. We must do this now so that
# any '-I' needed appears first.
pkg_root = os.path.dirname(os.path.abspath(__file__))
sip_file = module_config.get_sip_file(target_config)
head, tail = os.path.split(sip_file)
while head:
head, tail = os.path.split(head)
if tail != sip_file:
argv.append('-I')
argv.append(quote(os.path.join(pkg_root, tail)))
# Add the PyQt-specific flags.
if target_config.pyqt_package is not None:
# Add PyQt's .sip files to the search path.
argv.append('-I')
argv.append(quote(target_config.pyqt_sip_dir))
# Get the flags used for the main PyQt module.
argv.extend(target_config.pyqt_sip_flags.split())
# Add the backstop version.
argv.append('-B')
argv.append('Qt_6_0_0' if target_config.pyqt_package == 'PyQt5'
else 'Qt_5_0_0')
# Add the module-specific flags.
argv.extend(pkg_config.get_sip_flags(target_config))
if target_config.stubs_dir != '':
# Generate the stub file.
argv.append('-y')
argv.append(quote(module_config.pep484_stub_file + '.pyi'))
if pkg_config.qwt_api_file and target_config.api_dir != '':
# Generate the API file.
argv.append('-a')
argv.append(quote(module_config.name + '.api'))
if target_config.prot_is_public:
argv.append('-P');
if not opts.no_docstrings:
argv.append('-o');
if opts.concat:
argv.append('-j')
argv.append(str(opts.split))
if opts.tracing:
argv.append('-r')
argv.append('-c')
argv.append(os.path.abspath(module_config.name))
argv.append(os.path.join(pkg_root, sip_file))
check_file = os.path.join(module_config.name,
'sipAPI%s.h' % module_config.name)
_remove_file(check_file)
_run_command(' '.join(argv), opts.verbose)
if not os.access(check_file, os.F_OK):
error("Unable to create the C++ code.")
# Generate the .pro file.
_generate_pro(target_config, opts, module_config, all_installs)
def _get_qt_qmake_config(qmake_config, qt_version):
""" Return a dict of qmake configuration values for a specific Qt version.
"""
qt_qmake_config = {}
for name, value in qmake_config.items():
name_parts = name.split(':')
if len(name_parts) == 2 and name_parts[0] == qt_version:
qt_qmake_config[name_parts[1]] = value
return qt_qmake_config
def _write_qt_qmake_config(qt_qmake_config, pro):
""" Write the qmake configuration values to a .pro file. """
for name in ('QT', 'CONFIG', 'DEFINES', 'INCLUDEPATH', 'LIBS'):
value = qt_qmake_config.get(name)
if value:
pro.write(' %s += %s\n' % (name, value))
def _generate_pro(target_config, opts, module_config, all_installs):
""" Generate the .pro file for the module. target_config is the target
configuration. opts are the command line options. module_config is the
module configuration. all_installs is a list that is updated with the
files installed for this module.
"""
inform("Generating the .pro file for the %s module..." % module_config.name)
# Without the 'no_check_exist' magic the target.files must exist when qmake
# is run otherwise the install and uninstall targets are not generated.
qmake_config = module_config.get_qmake_configuration(target_config)
pro = open(os.path.join(module_config.name, module_config.name + '.pro'),
'w')
pro.write('TEMPLATE = lib\n')
qt = qmake_config.get('QT')
if qt:
pro.write('QT += %s\n' % qt)
if target_config.pyqt_package == 'PyQt5':
pro.write("QT += core gui widgets printsupport\n")
pro.write('CONFIG += %s\n' % ('debug' if target_config.debug else 'release'))
pro.write('CONFIG += %s\n' % ('staticlib' if opts.static else 'plugin plugin_bundle'))
config = qmake_config.get('CONFIG')
if config:
pro.write('CONFIG += %s\n' % config)
# Work around QTBUG-39300.
pro.write('CONFIG -= android_install\n')
qt5_qmake_config = _get_qt_qmake_config(qmake_config, 'Qt5')
qt4_qmake_config = _get_qt_qmake_config(qmake_config, 'Qt4')
if qt5_qmake_config or qt4_qmake_config:
pro.write('''
greaterThan(QT_MAJOR_VERSION, 4) {
''')
if qt5_qmake_config:
_write_qt_qmake_config(qt5_qmake_config, pro)
if qt4_qmake_config:
pro.write('} else {\n')
_write_qt_qmake_config(qt4_qmake_config, pro)
pro.write('}\n')
mname = module_config.name
pro.write('TARGET = %s\n' % mname)
if not opts.static:
pro.write('''
win32 {
PY_MODULE = %s.pyd
PY_MODULE_SRC = $(DESTDIR_TARGET)
LIBS += -L%s
} else {
PY_MODULE = %s.so
macx {
PY_MODULE_SRC = $(TARGET).plugin/Contents/MacOS/$(TARGET)
QMAKE_LFLAGS += "-undefined dynamic_lookup"
equals(QT_MAJOR_VERSION, 5) {
equals(QT_MINOR_VERSION, 5) {
QMAKE_RPATHDIR += $$[QT_INSTALL_LIBS]
}
}
} else {
PY_MODULE_SRC = $(TARGET)
}
}
QMAKE_POST_LINK = $(COPY_FILE) $$PY_MODULE_SRC $$PY_MODULE
target.CONFIG = no_check_exist
target.files = $$PY_MODULE
''' % (mname, quote(target_config.py_pylib_dir), mname))
pro.write('''
target.path = %s
INSTALLS += target
''' % quote(target_config.module_dir))
if sys.platform == 'win32':
fs = '{}.lib' if opts.static else '{}.pyd'
else:
fs = 'lib{}.a' if opts.static else '{}.so'
all_installs.append(target_config.module_dir + '/' + fs.format(mname))
# Change to the directory containing this script (in case of out-of-source
# builds).
pkg_root = os.path.dirname(os.path.abspath(__file__))
old_cwd = os.getcwd()
os.chdir(pkg_root)
sip_installs = module_config.get_sip_installs(target_config)
os.chdir(old_cwd)
if sip_installs is not None:
path, files = sip_installs
pro.write('''
sip.path = %s
sip.files =''' % quote(path))
rel_pkg_root = os.path.relpath(pkg_root)
for fn in files:
# The filename should be relative to the current directory and use
# POSIX separators.
fn = fn.replace('/', os.sep)
fn = os.path.join(rel_pkg_root, fn)
fn = fn.replace(os.sep, '/')
fn = os.path.normpath(fn)
pro.write(' \\\n ../%s' % fn)
pro.write('''
INSTALLS += sip
''')
all_installs.append(path)
pro.write('\n')
# These optimisations could apply to other platforms.
if module_config.no_exceptions:
if target_config.py_platform.startswith('linux') or target_config.py_platform == 'darwin':
pro.write('QMAKE_CXXFLAGS += -fno-exceptions\n')
if target_config.py_platform.startswith('linux') and not opts.static:
if target_config.py_version >= 0x030000:
entry_point = 'PyInit_%s' % mname
else:
entry_point = 'init%s' % mname
exp = open(os.path.join(mname, mname + '.exp'), 'wt')
exp.write('{ global: %s; local: *; };' % entry_point)
exp.close()
pro.write('QMAKE_LFLAGS += -Wl,--version-script=%s.exp\n' % mname)
if target_config.prot_is_public:
pro.write('DEFINES += SIP_PROTECTED_IS_PUBLIC protected=public\n')
defines = qmake_config.get('DEFINES')
if defines:
pro.write('DEFINES += %s\n' % defines)
pro.write('DEFINES += QWT_PYTHON_WRAPPER\n')
includepath = qmake_config.get('INCLUDEPATH')
if includepath:
pro.write('INCLUDEPATH += %s\n' % includepath)
# Make sure the SIP include directory is searched before the Python include
# directory if they are different.
pro.write('INCLUDEPATH += %s\n' % quote(target_config.sip_inc_dir))
if target_config.py_inc_dir != target_config.sip_inc_dir:
pro.write('INCLUDEPATH += %s\n' % quote(target_config.py_inc_dir))
libs = qmake_config.get('LIBS')
if libs:
if target_config.qwt_lib == None:
pro.write('LIBS += %s -lqwt\n' % libs)
else:
pro.write('LIBS += %s -l%s\n' % (libs,target_config.qwt_lib))
if not opts.static:
dylib = module_config.get_mac_wrapped_library_file(target_config)
if dylib:
pro.write('''
macx {
QMAKE_POST_LINK = $$QMAKE_POST_LINK$$escape_expand(\\\\n\\\\t)$$quote(install_name_tool -change %s %s $$PY_MODULE)
}
''' % (os.path.basename(dylib), dylib))
pro.write('\n')
pro.write('HEADERS = sipAPI%s.h\n' % mname)
pro.write('SOURCES =')
for s in sorted(os.listdir(module_config.name)):
if s.endswith('.cpp'):
pro.write(' \\\n %s' % s)
pro.write('\n')
if target_config.qmake_variables:
pro.write('\n'.join(target_config.qmake_variables) + '\n')
pro.close()
def _run_qmake(target_config, verbose, pro_name):
""" Run qmake against a .pro file. target_config is the target
configuration. verbose is set if the output is to be displayed. pro_name
is the name of the .pro file.
"""
inform("Generating the Makefiles...")
# qmake doesn't behave consistently if it is not run from the directory
# containing the .pro file - so make sure it is.
pro_dir, pro_file = os.path.split(pro_name)
if pro_dir != '':
cwd = os.getcwd()
os.chdir(pro_dir)
else:
cwd = None
mf = 'Makefile'
_remove_file(mf)
args = [quote(target_config.qmake)]
# Make sure all Makefiles are generated now in case qmake has been
# configured with environment variables.
args.append('-recursive')
if target_config.qmake_spec != '':
args.append('-spec')
args.append(target_config.qmake_spec)
args.append(pro_file)
_run_command(' '.join(args), verbose)
if not os.access(mf, os.F_OK):
error(
"%s failed to create a Makefile from %s." %
(target_config.qmake, pro_name))
# Restore the current directory.
if cwd is not None:
os.chdir(cwd)
def _run_command(cmd, verbose):
""" Run a command and display the output if requested. cmd is the command
to run. verbose is set if the output is to be displayed.
"""
if verbose:
sys.stdout.write(cmd + "\n")
fout = _get_command_output(cmd)
# Read stdout and stderr until there is no more output.
lout = fout.readline()
while lout:
if verbose:
if sys.hexversion >= 0x03000000:
sys.stdout.write(str(lout, encoding=sys.stdout.encoding))
else:
sys.stdout.write(lout)
lout = fout.readline()
fout.close()
try:
os.wait()
except:
pass
def _get_command_output(cmd):
""" Return a pipe from which a command's output can be read. cmd is the
command.
"""
try:
import subprocess
except ImportError:
_, sout = os.popen4(cmd)
return sout
p = subprocess.Popen(cmd, shell=True, stdin=subprocess.PIPE,
stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
return p.stdout
def _remove_file(fname):
""" Remove a file which may or may not exist. fname is the name of the
file.
"""
try:
os.remove(fname)
except OSError:
pass
def _check_sip(target_config, pkg_config, verbose):
""" Check that the version of sip is good enough. target_config is the
target configuration. pkg_config is the package configuration. verbose is
set if the output is to be displayed.
"""
if target_config.sip is None:
error(
"Make sure you have a working sip on your PATH or use the "
"--sip argument to explicitly specify a working sip.")
pipe = os.popen(' '.join([quote(target_config.sip), '-V']))
for l in pipe:
version_str = l.strip()
break
else:
error("'%s -V' did not generate any output." % target_config.sip)
pipe.close()
if '.dev' in version_str or 'snapshot' in version_str:
# We only need to distinguish between sip v4 and sip v5.
if target_config.using_sip5():
version = 0x050000
else:
version = 0x040000
else:
version = version_from_string(version_str)
if version is None:
error(
"'%s -V' generated unexpected output: '%s'." % (
target_config.sip, version_str))
min_sip_version = pkg_config.minimum_sip_version
if min_sip_version:
min_version = version_from_string(min_sip_version)
if version < min_version:
error(
"This version of %s requires sip %s or later." %
(pkg_config.descriptive_name, min_sip_version))
if version >= 0x050000:
# Install the sip.h file for the private sip module.
if target_config.sip_inc_dir is None:
target_config.sip_inc_dir = os.path.join(
os.path.abspath(os.getcwd()), 'include')
inform("Installing sip.h in %s..." % target_config.sip_inc_dir)
os.makedirs(target_config.sip_inc_dir, exist_ok=True)
argv = ['sip-module', '--sip-h']
if target_config.abi_version:
argv.append('--abi-version')
argv.append(target_config.abi_version)
argv.append('--target-dir')
argv.append(quote(target_config.sip_inc_dir)),
argv.append('PyQt5.sip')
_run_command(' '.join(argv), verbose)
if not os.access(os.path.join(target_config.sip_inc_dir, 'sip.h'), os.F_OK):
error(
"sip-module failed to install sip.h in %s." %
target_config.sip_inc_dir)
else:
if target_config.sip_inc_dir is None:
target_config.sip_inc_dir = target_config.py_venv_inc_dir
target_config.sip_version = version
target_config.sip_version_str = version_str
def _main(argv, pkg_config):
""" Create the configured package. argv is the list of command line
arguments. pkg_config is the package configuration.
"""
# Create the default target configuration.
target_config = _TargetConfiguration(pkg_config)
# Parse the command line.
p = _create_optparser(target_config, pkg_config)
opts, target_config.qmake_variables = p.parse_args()
target_config.apply_pre_options(opts)
# Query qmake for the basic configuration information.
target_config.get_qt_configuration(opts)
# Update the target configuration.
if pkg_config.user_configuration_file_is_supported:
config_file = opts.config_file
else:
config_file = None
if config_file is not None:
target_config.update_from_configuration_file(config_file)
else:
target_config.apply_sysroot()
target_config.apply_post_options(opts, pkg_config)
if target_config.pyqt_package is not None:
if target_config.pyqt_sip_flags is None:
target_config.introspect_pyqt(pkg_config)
# Check SIP is new enough.
_check_sip(target_config, pkg_config, opts.verbose)
# Perform any package specific checks now that all other information has
# been captured.
pkg_config.check_package(target_config)
# Tell the user what's been found.
_inform_user(target_config, pkg_config)
# Allow for module specific hacks.
pkg_config.pre_code_generation(target_config)
# Generate the code.
all_installs = []
for module_config in pkg_config.modules:
_generate_code(target_config, opts, pkg_config, module_config,
all_installs)
# Concatenate any .api files.
if pkg_config.qwt_api_file and target_config.api_dir != '':
inform("Generating the Qwt API file...")
f = open(pkg_config.qwt_api_file + '.api', 'w')
for module_config in pkg_config.modules:
api = open(module_config.name + '.api')
for l in api:
if target_config.pyqt_package is not None:
l = target_config.pyqt_package + '.' + l
f.write(l)
api.close()
os.remove(module_config.name + '.api')
f.close()
# Generate the top-level .pro file.
inform("Generating the top-level .pro file...")
pro_name = pkg_config.descriptive_name + '.pro'
pro = open(pro_name, 'w')
pro.write('''TEMPLATE = subdirs
CONFIG += ordered nostrip
SUBDIRS = %s
''' % ' '.join([module.name for module in pkg_config.modules]))
if target_config.stubs_dir != '':
stubs = [module.pep484_stub_file + '.pyi' for module in pkg_config.modules if module.pep484_stub_file]
if stubs:
pro.write('''
pep484_stubs.path = %s
pep484_stubs.files = %s
INSTALLS += pep484_stubs
''' % (target_config.stubs_dir, ' '.join(stubs)))
all_installs.extend(
[target_config.stubs_dir + '/' + pyi for pyi in stubs])
if pkg_config.qwt_api_file and target_config.api_dir != '':
api_dir = target_config.api_dir + '/api/python'
api_file = pkg_config.qwt_api_file + '.api'
pro.write('''
api.path = %s
api.files = %s
INSTALLS += api
''' % (api_dir, api_file))
all_installs.append(api_dir + '/' + api_file)
if target_config.distinfo:
# Allow for out-of-tree builds.
distinfo_dir = os.path.join(target_config.py_module_dir,
pkg_config.distinfo_name + '-' + pkg_config.version + '.dist-info')
mk_distinfo = os.path.join(os.path.dirname(os.path.abspath(__file__)),
'mk_distinfo.py')
run_mk_distinfo = '%s %s \\"$(INSTALL_ROOT)\\" %s installed.txt' % (
quote(sys.executable), quote(mk_distinfo), quote(distinfo_dir))
pro.write('''
distinfo.extra = %s
distinfo.path = %s
INSTALLS += distinfo
''' % (run_mk_distinfo, target_config.module_dir))
# Create the file containing the names of all installed files.
installed = open('installed.txt', 'w')
for install in all_installs:
installed.write(install + '\n')
installed.close()
pro.close()
# Generate the Makefile.
_run_qmake(target_config, opts.verbose, pro_name)
###############################################################################
# The script starts here.
###############################################################################
if __name__ == '__main__':
# Assume the product is a package containing multiple modules. If it isn't
# then create a dummy package containing the single module.
try:
pkg_config_type = PackageConfiguration
except NameError:
pkg_config_type = type('PackageConfiguration', (object, ), {})
if hasattr(pkg_config_type, 'modules'):
# Provide some default values.
pkg_config_type.distinfo_name = getattr(pkg_config_type,
'distinfo_name', '')
else:
mod_config_type = ModuleConfiguration
# Extract the package-specific attributes and methods.
pkg_config_type.descriptive_name = mod_config_type.descriptive_name
pkg_config_type.distinfo_name = getattr(mod_config_type,
'distinfo_name', '')
pkg_config_type.legacy_configuration_script = mod_config_type.legacy_configuration_script
pkg_config_type.minimum_sip_version = mod_config_type.minimum_sip_version
pkg_config_type.protected_is_public_is_supported = mod_config_type.protected_is_public_is_supported
pkg_config_type.pyqt4_is_supported = mod_config_type.pyqt4_is_supported
pkg_config_type.pyqt5_is_supported = mod_config_type.pyqt5_is_supported
pkg_config_type.pyqt5_is_default = mod_config_type.pyqt5_is_default
pkg_config_type.qwt_api_file = mod_config_type.qwt_api_file
pkg_config_type.support_email_address = mod_config_type.support_email_address
pkg_config_type.user_configuration_file_is_supported = mod_config_type.user_configuration_file_is_supported
pkg_config_type.user_pyqt_sip_flags_is_supported = mod_config_type.user_pyqt_sip_flags_is_supported
pkg_config_type.version = mod_config_type.version
pkg_config_type.init_target_configuration = staticmethod(
mod_config_type.init_target_configuration)
pkg_config_type.init_optparser = staticmethod(
mod_config_type.init_optparser)
pkg_config_type.apply_options = staticmethod(
mod_config_type.apply_options)
pkg_config_type.inform_user = staticmethod(
mod_config_type.inform_user)
pkg_config_type.pre_code_generation = staticmethod(
mod_config_type.pre_code_generation)
pkg_config_type.get_sip_flags = staticmethod(
mod_config_type.get_sip_flags)
# Note the name change.
pkg_config_type.check_package = staticmethod(
mod_config_type.check_module)
pkg_config_type.modules = [mod_config_type()]
pkg_config = pkg_config_type()
try:
_main(sys.argv, pkg_config)
except SystemExit:
raise
except:
if pkg_config.support_email_address:
sys.stderr.write(
"""An internal error occured. Please report all the output from the program,
including the following traceback, to %s.
""" % pkg_config.support_email_address)
raise
|