File size: 72,628 Bytes
d3de7c1 | 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 | #!/usr/bin/env python3
#
# Copyright (C) 2018 Linus Jahn <lnj@kaidan.im>
# Copyright (C) 2019-2025 Hiroshi Miura <miurahr@linux.com>
# Copyright (C) 2020, Aurélien Gâteau
#
# Permission is hereby granted, free of charge, to any person obtaining a copy of
# this software and associated documentation files (the "Software"), to deal in
# the Software without restriction, including without limitation the rights to
# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
# the Software, and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
import argparse
import errno
import gc
import multiprocessing
import os
import platform
import posixpath
import re
import signal
import subprocess
import sys
import tarfile
import time
import zipfile
from logging import getLogger
from logging.handlers import QueueHandler
from pathlib import Path
from tempfile import TemporaryDirectory
from typing import List, Optional, Tuple, cast
import aqt
from aqt.archives import QtArchives, QtPackage, SrcDocExamplesArchives, ToolArchives
from aqt.commercial import CommercialInstaller
from aqt.exceptions import (
AqtException,
ArchiveChecksumError,
ArchiveDownloadError,
ArchiveExtractionError,
ArchiveListError,
CliInputError,
CliKeyboardInterrupt,
DiskAccessNotPermitted,
OutOfDiskSpace,
OutOfMemory,
)
from aqt.helper import (
MyQueueListener,
Settings,
download_installer,
downloadBinaryFile,
extract_auth,
get_hash,
get_os_name,
get_qt_installer_name,
prepare_installer,
retry_on_bad_connection,
retry_on_errors,
safely_run_save_output,
setup_logging,
)
from aqt.metadata import ArchiveId, MetadataFactory, QtRepoProperty, SimpleSpec, Version, show_list, suggested_follow_up
from aqt.updater import Updater, dir_for_version
try:
import py7zr
EXT7Z = False
except ImportError:
EXT7Z = True
class BaseArgumentParser(argparse.ArgumentParser):
"""Global options and subcommand trick"""
config: Optional[str]
func: object
class ListArgumentParser(BaseArgumentParser):
"""List-* command parser arguments and options"""
arch: Optional[str]
archives: List[str]
extension: str
extensions: str
host: str
last_version: str
latest_version: bool
long: bool
long_modules: List[str]
modules: List[str]
qt_version_spec: str
spec: str
target: str
email: Optional[str]
pw: Optional[str]
search_terms: Optional[str]
class ListToolArgumentParser(ListArgumentParser):
"""List-tool command options"""
tool_name: str
tool_version: str
class CommonInstallArgParser(BaseArgumentParser):
"""Install-*/install common arguments"""
target: str
host: str
outputdir: Optional[str]
base: Optional[str]
timeout: Optional[float]
external: Optional[str]
internal: bool
keep: bool
archive_dest: Optional[str]
dry_run: bool
class InstallArgParser(CommonInstallArgParser):
"""Install-qt arguments and options"""
override: Optional[List[str]]
arch: Optional[str]
qt_version: str
qt_version_spec: str
version: Optional[str]
email: Optional[str]
pw: Optional[str]
operation_does_not_exist_error: str
overwrite_target_dir: str
stop_processes_for_updates: str
installation_error_with_cancel: str
installation_error_with_ignore: str
associate_common_filetypes: str
telemetry: str
modules: Optional[List[str]]
archives: Optional[List[str]]
noarchives: bool
autodesktop: bool
class InstallToolArgParser(CommonInstallArgParser):
"""Install-tool arguments and options"""
tool_name: str
version: Optional[str]
tool_variant: Optional[str]
class Cli:
"""CLI main class to parse command line argument and launch proper functions."""
__slot__ = ["parser", "combinations", "logger"]
UNHANDLED_EXCEPTION_CODE = 254
def __init__(self) -> None:
parser = argparse.ArgumentParser(
prog="aqt",
description="Another unofficial Qt Installer.\naqt helps you install Qt SDK, tools, examples and others\n",
formatter_class=argparse.RawTextHelpFormatter,
add_help=True,
)
parser.add_argument(
"-c",
"--config",
type=argparse.FileType("r"),
help="Configuration ini file.",
)
subparsers = parser.add_subparsers(
title="subcommands",
description="aqt accepts several subcommands:\n"
"install-* subcommands are commands that install components\n"
"list-* subcommands are commands that show available components\n",
help="Please refer to each help message by using '--help' with each subcommand",
)
self._make_all_parsers(subparsers)
parser.set_defaults(func=self.show_help)
self.parser = parser
def run(self, arg=None) -> int:
args = self.parser.parse_args(arg)
self._setup_settings(args)
try:
args.func(args)
return 0
except AqtException as e:
self.logger.error(format(e), exc_info=Settings.print_stacktrace_on_error)
if e.should_show_help:
self.show_help()
return 1
except Exception as e:
# If we didn't account for it, and wrap it in an AqtException, it's a bug.
self.logger.exception(e) # Print stack trace
self.logger.error(
f"{self._format_aqt_version()}\n"
f"Working dir: `{os.getcwd()}`\n"
f"Arguments: `{sys.argv}` Host: `{platform.uname()}`\n"
"===========================PLEASE FILE A BUG REPORT===========================\n"
"You have discovered a bug in aqt.\n"
"Please file a bug report at https://github.com/miurahr/aqtinstall/issues\n"
"Please remember to include a copy of this program's output in your report."
)
return Cli.UNHANDLED_EXCEPTION_CODE
def _set_sevenzip(self, external: Optional[str]) -> Optional[str]:
sevenzip = external
fallback = Settings.zipcmd
if sevenzip is None:
if EXT7Z:
self.logger.warning(f"The py7zr module failed to load. Falling back to '{fallback}' for .7z extraction.")
self.logger.warning("You can use the '--external | -E' flags to select your own extraction tool.")
sevenzip = fallback
else:
# Just use py7zr
return None
try:
subprocess.run(
[sevenzip, "--help"],
stdout=subprocess.DEVNULL,
stderr=subprocess.DEVNULL,
)
return sevenzip
except FileNotFoundError as e:
qualifier = "Specified" if sevenzip == external else "Fallback"
raise CliInputError(f"{qualifier} 7zip command executable does not exist: '{sevenzip}'") from e
@staticmethod
def _set_arch(arch: Optional[str], os_name: str, target: str, qt_version_or_spec: str) -> str:
"""Choose a default architecture, if one can be determined"""
if arch is not None and arch != "":
return arch
if os_name == "linux" and target == "desktop":
try:
if Version(qt_version_or_spec) >= Version("6.7.0"):
return "linux_gcc_64"
else:
return "gcc_64"
except ValueError:
return "gcc_64"
elif os_name == "linux_arm64" and target == "desktop":
return "linux_gcc_arm64"
elif os_name == "mac" and target == "desktop":
return "clang_64"
elif os_name == "mac" and target == "ios":
return "ios"
elif target == "android":
try:
if Version(qt_version_or_spec) >= Version("5.14.0"):
return "android"
except ValueError:
pass
elif os_name == "windows_arm64" and target == "desktop":
return "windows_msvc2022_arm64"
raise CliInputError("Please supply a target architecture.", should_show_help=True)
def _check_mirror(self, mirror):
if mirror is None:
pass
elif mirror.startswith("http://") or mirror.startswith("https://") or mirror.startswith("ftp://"):
pass
else:
return False
return True
@staticmethod
def _determine_qt_version(
qt_version_or_spec: str, host: str, target: str, arch: str, base_url: str = Settings.baseurl
) -> Version:
def choose_highest(x: Optional[Version], y: Optional[Version]) -> Optional[Version]:
if x and y:
return max(x, y)
return x or y
def opt_version_for_spec(ext: str, _spec: SimpleSpec) -> Optional[Version]:
try:
meta = MetadataFactory(ArchiveId("qt", host, target), spec=_spec, base_url=base_url)
return meta.fetch_latest_version(ext)
except AqtException:
return None
try:
return Version(qt_version_or_spec)
except ValueError:
pass
try:
spec = SimpleSpec(qt_version_or_spec)
except ValueError as e:
raise CliInputError(f"Invalid version or SimpleSpec: '{qt_version_or_spec}'\n" + SimpleSpec.usage()) from e
else:
version: Optional[Version] = None
for ext in QtRepoProperty.possible_extensions_for_arch(arch):
version = choose_highest(version, opt_version_for_spec(ext, spec))
if not version:
raise CliInputError(
f"No versions of Qt exist for spec={spec} with host={host}, target={target}, arch={arch}"
)
getLogger("aqt.installer").info(f"Resolved spec '{qt_version_or_spec}' to {version}")
return version
@staticmethod
def choose_archive_dest(archive_dest: Optional[str], keep: bool, temp_dir: str) -> Path:
"""
Choose archive download destination, based on context.
There are three potential behaviors here:
1. By default, return a temp directory that will be removed on program exit.
2. If the user has asked to keep archives, but has not specified a destination,
we return Settings.archive_download_location ("." by default).
3. If the user has asked to keep archives and specified a destination,
we create the destination dir if it doesn't exist, and return that directory.
"""
if not archive_dest:
return Path(Settings.archive_download_location if keep else temp_dir)
dest = Path(archive_dest)
dest.mkdir(parents=True, exist_ok=True)
return dest
def run_install_qt(self, args: InstallArgParser):
"""Run install subcommand"""
start_time = time.perf_counter()
self.show_aqt_version()
target: str = args.target
os_name: str = args.host
effective_os_name: str = Cli._get_effective_os_name(os_name)
qt_version_or_spec: str = getattr(args, "qt_version", getattr(args, "qt_version_spec", ""))
arch: str = self._set_arch(args.arch, os_name, target, qt_version_or_spec)
keep: bool = args.keep or Settings.always_keep_archives
archive_dest: Optional[str] = args.archive_dest
dry_run: bool = args.dry_run
output_dir = args.outputdir
if output_dir is None:
base_dir = os.getcwd()
else:
base_dir = output_dir
if args.timeout is not None:
timeout = (args.timeout, args.timeout)
else:
timeout = (Settings.connection_timeout, Settings.response_timeout)
modules = args.modules
sevenzip = self._set_sevenzip(args.external)
if args.base is not None:
if not self._check_mirror(args.base):
raise CliInputError(
"The `--base` option requires a url where the path `online/qtsdkrepository` exists.",
should_show_help=True,
)
base = args.base
else:
base = Settings.baseurl
if hasattr(args, "qt_version_spec"):
qt_version: str = str(Cli._determine_qt_version(args.qt_version_spec, os_name, target, arch, base_url=base))
else:
qt_version = args.qt_version
Cli._validate_version_str(qt_version)
if qt_version != qt_version_or_spec:
arch = self._set_arch(args.arch, os_name, target, qt_version)
if hasattr(args, "use_official_installer") and args.use_official_installer is not None:
if len(args.use_official_installer) not in [0, 2]:
raise CliInputError(
"When providing arguments to --use-official-installer, exactly 2 arguments are required: "
"--use-official-installer email password"
)
self.logger.info("Using official Qt installer")
commercial_args = InstallArgParser()
# Core parameters required by install-qt-official
commercial_args.target = args.target
commercial_args.arch = self._set_arch(
args.arch, args.host, args.target, getattr(args, "qt_version", getattr(args, "qt_version_spec", ""))
)
commercial_args.version = qt_version
email = None
password = None
if len(args.use_official_installer) == 2:
email, password = args.use_official_installer
self.logger.info("Using credentials provided with --use-official-installer")
# Optional parameters
commercial_args.email = email or getattr(args, "email", None)
commercial_args.pw = password or getattr(args, "pw", None)
commercial_args.outputdir = args.outputdir
commercial_args.modules = args.modules
commercial_args.base = getattr(args, "base", None)
commercial_args.dry_run = getattr(args, "dry_run", False)
commercial_args.override = None
ignored_options = []
if getattr(args, "noarchives", False):
ignored_options.append("--noarchives")
if getattr(args, "autodesktop", False):
ignored_options.append("--autodesktop")
if getattr(args, "archives", None):
ignored_options.append("--archives")
if getattr(args, "timeout", False):
ignored_options.append("--timeout")
if getattr(args, "keep", False):
ignored_options.append("--keep")
if getattr(args, "archive_dest", False):
ignored_options.append("--archive_dest")
if ignored_options:
self.logger.warning("Options ignored because you requested the official installer:")
self.logger.warning(", ".join(ignored_options))
return self.run_install_qt_commercial(commercial_args, print_version=False)
archives = args.archives
if args.noarchives:
if modules is None:
raise CliInputError("When `--noarchives` is set, the `--modules` option is mandatory.")
if archives is not None:
raise CliInputError("Options `--archives` and `--noarchives` are mutually exclusive.")
else:
if modules is not None and archives is not None:
archives.extend(modules)
nopatch = args.noarchives or (archives is not None and "qtbase" not in archives) # type: bool
should_autoinstall: bool = args.autodesktop
_version = Version(qt_version)
base_path = Path(base_dir)
# Determine if 'all' extra modules should be included
all_extra = True if modules is not None and "all" in modules else False
expect_desktop_archdir, autodesk_arch = self._get_autodesktop_dir_and_arch(
should_autoinstall, os_name, target, base_path, _version, arch
)
# Main installation
qt_archives: QtArchives = retry_on_bad_connection(
lambda base_url: QtArchives(
os_name,
target,
qt_version,
arch,
base=base_url,
subarchives=archives,
modules=modules,
all_extra=all_extra,
is_include_base_package=not args.noarchives,
timeout=timeout,
),
base,
)
target_config = qt_archives.get_target_config()
target_config.os_name = effective_os_name
with TemporaryDirectory() as temp_dir:
_archive_dest = Cli.choose_archive_dest(archive_dest, keep, temp_dir)
run_installer(qt_archives.get_packages(), base_dir, sevenzip, keep, _archive_dest, dry_run=dry_run)
if dry_run:
return
if not nopatch:
Updater.update(target_config, base_path, expect_desktop_archdir)
# If autodesktop is enabled and we need a desktop installation, do it first
if should_autoinstall and autodesk_arch is not None:
is_wasm = arch.startswith("wasm")
is_msvc = "msvc" in arch
is_win_desktop_msvc_arm64 = (
effective_os_name == "windows"
and target == "desktop"
and is_msvc
and arch.endswith(("arm64", "arm64_cross_compiled"))
)
if is_win_desktop_msvc_arm64:
qt_type = "MSVC Arm64"
elif is_wasm:
qt_type = "Qt6-WASM"
else:
qt_type = target
# Create new args for desktop installation
self.logger.info("")
self.logger.info(
f"Autodesktop will now install {effective_os_name} desktop "
f"{qt_version} {autodesk_arch} as required by {qt_type}"
)
desktop_args = args
args.autodesktop = False
args.host = effective_os_name
args.target = "desktop"
args.arch = autodesk_arch
# Run desktop installation first
self.run_install_qt(desktop_args)
else:
self.logger.info("Finished installation")
self.logger.info("Time elapsed: {time:.8f} second".format(time=time.perf_counter() - start_time))
def _run_src_doc_examples(self, flavor, args, cmd_name: Optional[str] = None):
self.show_aqt_version()
if getattr(args, "target", None) is not None:
self._warn_on_deprecated_parameter("target", args.target)
target = "desktop" # The only valid target for src/doc/examples is "desktop"
os_name = args.host
output_dir = args.outputdir
if output_dir is None:
base_dir = os.getcwd()
else:
base_dir = output_dir
keep: bool = args.keep or Settings.always_keep_archives
archive_dest: Optional[str] = args.archive_dest
if args.base is not None:
base = args.base
else:
base = Settings.baseurl
if hasattr(args, "qt_version_spec"):
qt_version = str(Cli._determine_qt_version(args.qt_version_spec, os_name, target, arch="", base_url=base))
else:
qt_version = args.qt_version
Cli._validate_version_str(qt_version)
# Override target/os for recent Qt
if Version(qt_version) in SimpleSpec(">=6.7.0"):
target = "qt"
os_name = "all_os"
if args.timeout is not None:
timeout = (args.timeout, args.timeout)
else:
timeout = (Settings.connection_timeout, Settings.response_timeout)
sevenzip = self._set_sevenzip(args.external)
modules = getattr(args, "modules", None) # `--modules` is invalid for `install-src`
archives = args.archives
all_extra = True if modules is not None and "all" in modules else False
srcdocexamples_archives: SrcDocExamplesArchives = retry_on_bad_connection(
lambda base_url: SrcDocExamplesArchives(
flavor,
os_name,
target,
qt_version,
base=base_url,
subarchives=archives,
modules=modules,
all_extra=all_extra,
timeout=timeout,
),
base,
)
with TemporaryDirectory() as temp_dir:
_archive_dest = Cli.choose_archive_dest(archive_dest, keep, temp_dir)
run_installer(
srcdocexamples_archives.get_packages(), base_dir, sevenzip, keep, _archive_dest, dry_run=args.dry_run
)
self.logger.info("Finished installation")
def run_install_src(self, args):
"""Run src subcommand"""
if not hasattr(args, "qt_version"):
base = args.base if hasattr(args, "base") else Settings.baseurl
args.qt_version = str(
Cli._determine_qt_version(args.qt_version_spec, args.host, args.target, arch="", base_url=base)
)
if args.kde and args.qt_version != "5.15.2":
raise CliInputError("KDE patch: unsupported version!!")
start_time = time.perf_counter()
self._run_src_doc_examples("src", args)
if args.kde:
if args.outputdir is None:
target_dir = os.path.join(os.getcwd(), args.qt_version, "Src")
else:
target_dir = os.path.join(args.outputdir, args.qt_version, "Src")
Updater.patch_kde(target_dir)
self.logger.info("Time elapsed: {time:.8f} second".format(time=time.perf_counter() - start_time))
def run_install_example(self, args):
"""Run example subcommand"""
start_time = time.perf_counter()
self._run_src_doc_examples("examples", args, cmd_name="example")
self.logger.info("Time elapsed: {time:.8f} second".format(time=time.perf_counter() - start_time))
def run_install_doc(self, args):
"""Run doc subcommand"""
start_time = time.perf_counter()
self._run_src_doc_examples("doc", args)
self.logger.info("Time elapsed: {time:.8f} second".format(time=time.perf_counter() - start_time))
def run_install_tool(self, args: InstallToolArgParser):
"""Run tool subcommand"""
start_time = time.perf_counter()
self.show_aqt_version()
tool_name = args.tool_name # such as tools_openssl_x64
os_name = args.host # windows, linux and mac
target = args.target # desktop, android and ios
output_dir = args.outputdir
if output_dir is None:
base_dir = os.getcwd()
else:
base_dir = output_dir
sevenzip = self._set_sevenzip(args.external)
version = getattr(args, "version", None)
if version is not None:
Cli._validate_version_str(version, allow_minus=True)
keep: bool = args.keep or Settings.always_keep_archives
archive_dest: Optional[str] = args.archive_dest
if args.base is not None:
base = args.base
else:
base = Settings.baseurl
if args.timeout is not None:
timeout = (args.timeout, args.timeout)
else:
timeout = (Settings.connection_timeout, Settings.response_timeout)
if args.tool_variant is None:
archive_id = ArchiveId("tools", os_name, target)
meta = MetadataFactory(archive_id, base_url=base, is_latest_version=True, tool_name=tool_name)
try:
archs: List[str] = cast(list, meta.getList())
except ArchiveDownloadError as e:
msg = f"Failed to locate XML data for the tool '{tool_name}'."
raise ArchiveListError(msg, suggested_action=suggested_follow_up(meta)) from e
else:
archs = [args.tool_variant]
for arch in archs:
tool_archives: ToolArchives = retry_on_bad_connection(
lambda base_url: ToolArchives(
os_name=os_name,
tool_name=tool_name,
target=target,
base=base_url,
version_str=version,
arch=arch,
timeout=timeout,
),
base,
)
with TemporaryDirectory() as temp_dir:
_archive_dest = Cli.choose_archive_dest(archive_dest, keep, temp_dir)
run_installer(tool_archives.get_packages(), base_dir, sevenzip, keep, _archive_dest, dry_run=args.dry_run)
self.logger.info("Finished installation")
self.logger.info("Time elapsed: {time:.8f} second".format(time=time.perf_counter() - start_time))
def run_list_qt(self, args: ListArgumentParser):
"""Print versions of Qt, extensions, modules, architectures"""
if hasattr(args, "use_official_installer") and args.use_official_installer is not None:
if len(args.use_official_installer) not in [0, 2]:
raise CliInputError(
"When providing arguments to --use-official-installer, exactly 2 arguments are required: "
"--use-official-installer email password"
)
self.logger.info("Using official Qt installer for search")
commercial_search_args = ListArgumentParser()
email = None
password = None
if len(args.use_official_installer) == 2:
email, password = args.use_official_installer
self.logger.info("Using credentials provided with --use-official-installer")
commercial_search_args.email = email or getattr(args, "email", None)
commercial_search_args.pw = password or getattr(args, "pw", None)
target_str = ""
version_str = ""
if hasattr(args, "target") and args.target is not None:
target_str = args.target
if hasattr(args, "arch") and args.arch is not None:
try:
version = Version(args.arch)
version_str = f"{version.major}{version.minor}{version.patch}"
except Exception as e:
self.logger.warning(f"{e}. Ignoring 'arch' value")
commercial_search_args.search_terms = [rf"^.*{re.escape(version_str)}\.{re.escape(target_str)}.*$"]
ignored_options = []
if getattr(args, "extensions", False):
ignored_options.append("--extensions")
if getattr(args, "extension", False):
ignored_options.append("--extension")
if getattr(args, "modules", None):
ignored_options.append("--modules")
if getattr(args, "long_modules", False):
ignored_options.append("--long_modules")
if getattr(args, "spec", False):
ignored_options.append("--spec")
if getattr(args, "archives", False):
ignored_options.append("--archives")
if getattr(args, "latest-version", False):
ignored_options.append("--latest-version")
if ignored_options:
self.logger.warning("Options ignored because you requested the official installer:")
self.logger.warning(", ".join(ignored_options))
return self.run_list_qt_commercial(commercial_search_args, print_version=False)
if args.extensions:
self._warn_on_deprecated_parameter("extensions", args.extensions)
self.logger.warning(
"The '--extensions' flag will always return an empty list, "
"because there are no useful arguments for the '--extension' flag."
)
print("")
return
if args.extension:
self._warn_on_deprecated_parameter("extension", args.extension)
self.logger.warning("The '--extension' flag will be ignored.")
if not args.target:
print(" ".join(ArchiveId.TARGETS_FOR_HOST[args.host]))
return
if args.target not in ArchiveId.TARGETS_FOR_HOST[args.host]:
raise CliInputError("'{0.target}' is not a valid target for host '{0.host}'".format(args))
if args.modules:
assert len(args.modules) == 2, "broken argument parser for list-qt"
modules_query = MetadataFactory.ModulesQuery(args.modules[0], args.modules[1])
modules_ver, is_long = args.modules[0], False
elif args.long_modules:
assert args.long_modules and len(args.long_modules) == 2, "broken argument parser for list-qt"
modules_query = MetadataFactory.ModulesQuery(args.long_modules[0], args.long_modules[1])
modules_ver, is_long = args.long_modules[0], True
else:
modules_ver, modules_query, is_long = None, None, False
for version_str in (modules_ver, args.arch, args.archives[0] if args.archives else None):
Cli._validate_version_str(version_str, allow_latest=True, allow_empty=True)
spec = None
try:
if args.spec is not None:
spec = SimpleSpec(args.spec)
except ValueError as e:
raise CliInputError(f"Invalid version specification: '{args.spec}'.\n" + SimpleSpec.usage()) from e
meta = MetadataFactory(
archive_id=ArchiveId("qt", args.host, args.target),
spec=spec,
is_latest_version=args.latest_version,
modules_query=modules_query,
is_long_listing=is_long,
architectures_ver=args.arch,
archives_query=args.archives,
)
show_list(meta)
def run_list_tool(self, args: ListToolArgumentParser):
"""Print tools"""
if not args.target:
print(" ".join(ArchiveId.TARGETS_FOR_HOST[args.host]))
return
if args.target not in ArchiveId.TARGETS_FOR_HOST[args.host]:
raise CliInputError("'{0.target}' is not a valid target for host '{0.host}'".format(args))
meta = MetadataFactory(
archive_id=ArchiveId("tools", args.host, args.target),
tool_name=args.tool_name,
is_long_listing=args.long,
)
show_list(meta)
def run_list_src_doc_examples(self, args: ListArgumentParser, cmd_type: str):
target = "desktop"
version = Cli._determine_qt_version(args.qt_version_spec, args.host, target, arch="")
if version >= Version("6.7.0"):
target = "qt"
host = "all_os"
else:
host = args.host
is_fetch_modules: bool = getattr(args, "modules", False)
meta = MetadataFactory(
archive_id=ArchiveId("qt", host, target),
src_doc_examples_query=MetadataFactory.SrcDocExamplesQuery(cmd_type, version, is_fetch_modules),
)
show_list(meta)
def run_install_qt_commercial(self, args: InstallArgParser, print_version: Optional[bool] = True) -> None:
"""Execute commercial Qt installation"""
if print_version:
self.show_aqt_version()
try:
if args.override:
username, password, override_args = extract_auth(args.override)
commercial_installer = CommercialInstaller(
target="", # Empty string as placeholder
arch="",
version=None,
logger=self.logger,
base_url=args.base if args.base is not None else Settings.baseurl,
override=override_args,
no_unattended=not Settings.qt_installer_unattended,
username=username or args.email,
password=password or args.pw,
dry_run=args.dry_run,
)
else:
if not all([args.target, args.arch, args.version]):
raise CliInputError("target, arch, and version are required")
commercial_installer = CommercialInstaller(
target=args.target,
arch=args.arch,
version=args.version,
username=args.email,
password=args.pw,
output_dir=args.outputdir,
logger=self.logger,
base_url=args.base if args.base is not None else Settings.baseurl,
no_unattended=not Settings.qt_installer_unattended,
modules=args.modules,
dry_run=args.dry_run,
)
commercial_installer.install()
Settings.qt_installer_cleanup()
except Exception as e:
self.logger.error(f"Error installing official installer: {str(e)}")
finally:
self.logger.info("Done")
def show_help(self, args=None):
"""Display help message"""
self.parser.print_help()
def _format_aqt_version(self) -> str:
py_version = platform.python_version()
py_impl = platform.python_implementation()
py_build = platform.python_compiler()
return f"aqtinstall(aqt) v{aqt.__version__} on Python {py_version} [{py_impl} {py_build}]"
def show_aqt_version(self, args: Optional[list[str]] = None) -> None:
"""Display version information"""
self.logger.info(self._format_aqt_version())
def _set_install_qt_parser(self, install_qt_parser):
install_qt_parser.set_defaults(func=self.run_install_qt)
install_qt_parser.add_argument(
"host",
choices=["linux", "linux_arm64", "mac", "windows", "windows_arm64", "all_os"],
help="host os name",
)
install_qt_parser.add_argument(
"target",
choices=["desktop", "winrt", "android", "ios", "wasm", "qt"],
help="Target SDK",
)
install_qt_parser.add_argument(
"qt_version_spec",
metavar="(VERSION | SPECIFICATION)",
help='Qt version in the format of "5.X.Y" or SimpleSpec like "5.X" or "<6.X"',
)
install_qt_parser.add_argument(
"arch",
nargs="?",
help="\ntarget linux/desktop: linux_gcc_64, gcc_64, wasm_32"
"\ntarget mac/desktop: clang_64, wasm_32"
"\ntarget mac/ios: ios"
"\nwindows/desktop: win64_msvc2022_64"
"\n win64_msvc2019_64, win32_msvc2019"
"\n win64_msvc2017_64, win32_msvc2017"
"\n win64_msvc2015_64, win32_msvc2015"
"\n win64_mingw81, win32_mingw81"
"\n win64_mingw73, win32_mingw73"
"\n win32_mingw53"
"\n wasm_32"
"\nwindows/winrt: win64_msvc2019_winrt_x64, win64_msvc2019_winrt_x86"
"\n win64_msvc2017_winrt_x64, win64_msvc2017_winrt_x86"
"\n win64_msvc2019_winrt_armv7"
"\n win64_msvc2017_winrt_armv7"
"\nandroid: Qt 5.14: android (optional)"
"\n Qt 5.13 or below: android_x86_64, android_arm64_v8a"
"\n android_x86, android_armv7"
"\nall_os/wasm: wasm_singlethread, wasm_multithread",
)
self._set_common_options(install_qt_parser)
self._set_module_options(install_qt_parser)
self._set_archive_options(install_qt_parser)
install_qt_parser.add_argument(
"--noarchives",
action="store_true",
help="No base packages; allow mod amendment with --modules option.",
)
install_qt_parser.add_argument(
"--autodesktop",
action="store_true",
help="For Qt6 android, ios, wasm, and msvc_arm64 installations, an additional desktop Qt installation is "
"required. When enabled, this option installs the required desktop version automatically. "
"It has no effect when the desktop installation is not required.",
)
install_qt_parser.add_argument(
"--use-official-installer",
nargs="*",
default=None,
metavar=("EMAIL", "PASSWORD"),
help="Use the official Qt installer for installation instead of the aqt downloader. "
"Can be used without arguments or with email and password: --use-official-installer email password. "
"This redirects to install-qt-official. "
"Arguments not compatible with the official installer will be ignored.",
)
def _set_install_tool_parser(self, install_tool_parser):
install_tool_parser.set_defaults(func=self.run_install_tool)
install_tool_parser.add_argument(
"host",
choices=["linux", "linux_arm64", "mac", "windows", "windows_arm64", "all_os"],
help="host os name",
)
install_tool_parser.add_argument(
"target",
default=None,
choices=["desktop", "winrt", "android", "ios", "wasm", "qt"],
help="Target SDK.",
)
install_tool_parser.add_argument("tool_name", help="Name of tool such as tools_ifw, tools_mingw")
tool_variant_opts = {"nargs": "?", "default": None}
install_tool_parser.add_argument(
"tool_variant",
**tool_variant_opts,
help="Name of tool variant, such as qt.tools.ifw.41. "
"Please use 'aqt list-tool' to list acceptable values for this parameter.",
)
self._set_common_options(install_tool_parser)
def _set_install_qt_commercial_parser(self, install_qt_commercial_parser: argparse.ArgumentParser) -> None:
install_qt_commercial_parser.set_defaults(func=self.run_install_qt_commercial)
# Create mutually exclusive group for override vs standard parameters
exclusive_group = install_qt_commercial_parser.add_mutually_exclusive_group()
exclusive_group.add_argument(
"--override",
nargs=argparse.REMAINDER,
help="Will ignore all other parameters and use everything after this parameter as "
"input for the official Qt installer",
)
# Make standard arguments optional when override is used by adding a custom action
class ConditionalRequiredAction(argparse.Action):
def __call__(self, parser, namespace, values, option_string=None) -> None:
if not hasattr(namespace, "override") or not namespace.override:
setattr(namespace, self.dest, values)
install_qt_commercial_parser.add_argument(
"target",
nargs="?",
choices=["desktop", "android", "ios"],
help="Target platform",
action=ConditionalRequiredAction,
)
install_qt_commercial_parser.add_argument(
"arch", nargs="?", help="Target architecture", action=ConditionalRequiredAction
)
install_qt_commercial_parser.add_argument("version", nargs="?", help="Qt version", action=ConditionalRequiredAction)
install_qt_commercial_parser.add_argument(
"--email",
help="Qt account email",
)
install_qt_commercial_parser.add_argument(
"--pw",
help="Qt account password",
)
install_qt_commercial_parser.add_argument(
"-m",
"--modules",
nargs="*",
help="Add modules",
)
self._set_common_options(install_qt_commercial_parser)
def _set_list_qt_commercial_parser(self, list_qt_commercial_parser: argparse.ArgumentParser) -> None:
"""Configure parser for list-qt-official command with flexible argument handling."""
list_qt_commercial_parser.set_defaults(func=self.run_list_qt_commercial)
list_qt_commercial_parser.add_argument(
"--email",
help="Qt account email",
)
list_qt_commercial_parser.add_argument(
"--pw",
help="Qt account password",
)
# Capture all remaining arguments as search terms
list_qt_commercial_parser.add_argument(
"search_terms",
nargs="*", # Zero or more arguments
help="Search terms (all non-option arguments are treated as search terms)",
)
def run_list_qt_commercial(self, args: ListArgumentParser, print_version: Optional[bool] = True) -> None:
"""Execute Qt commercial package listing."""
if print_version:
self.show_aqt_version()
# Create temporary directory for installer
temp_dir = Settings.qt_installer_temp_path
temp_path = Path(temp_dir)
if not temp_path.exists():
temp_path.mkdir(parents=True, exist_ok=True)
else:
Settings.qt_installer_cleanup()
# Get installer based on OS
installer_filename = get_qt_installer_name()
installer_path = temp_path / installer_filename
try:
# Download installer
self.logger.info(f"Downloading Qt installer to {installer_path}")
timeout = (Settings.connection_timeout, Settings.response_timeout)
download_installer(Settings.baseurl, installer_filename, installer_path, timeout)
installer_path = prepare_installer(installer_path, get_os_name())
# Build command
cmd = [str(installer_path), "--accept-licenses", "--accept-obligations", "--confirm-command"]
if args.email and args.pw:
cmd.extend(["--email", args.email, "--pw", args.pw])
cmd.append("search")
# Add all search terms if present
if args.search_terms:
cmd.extend(args.search_terms)
# Run search
output = safely_run_save_output(cmd, Settings.qt_installer_timeout)
if output.stdout:
self.logger.info(output.stdout)
if output.stderr:
for line in output.stderr.splitlines():
self.logger.warning(line)
except Exception as e:
self.logger.error(f"Failed to list Qt official packages: {e}")
finally:
Settings.qt_installer_cleanup()
def _warn_on_deprecated_command(self, old_name: str, new_name: str) -> None:
self.logger.warning(
f"The command '{old_name}' is deprecated and marked for removal in a future version of aqt.\n"
f"In the future, please use the command '{new_name}' instead."
)
def _warn_on_deprecated_parameter(self, parameter_name: str, value: str):
self.logger.warning(
f"The parameter '{parameter_name}' with value '{value}' is deprecated and marked for "
f"removal in a future version of aqt.\n"
f"In the future, please omit this parameter."
)
def _make_all_parsers(self, subparsers: argparse._SubParsersAction) -> None:
"""Creates all command parsers and adds them to the subparsers"""
def make_parser_it(cmd: str, desc: str, set_parser_cmd, formatter_class):
kwargs = {"formatter_class": formatter_class} if formatter_class else {}
p = subparsers.add_parser(cmd, description=desc, **kwargs)
set_parser_cmd(p)
def make_parser_sde(cmd: str, desc: str, action, is_add_kde: bool, is_add_modules: bool = True):
parser = subparsers.add_parser(cmd, description=desc)
parser.set_defaults(func=action)
self._set_common_arguments(parser, is_target_deprecated=True)
self._set_common_options(parser)
if is_add_modules:
self._set_module_options(parser)
self._set_archive_options(parser)
if is_add_kde:
parser.add_argument("--kde", action="store_true", help="patching with KDE patch kit.")
def make_parser_list_sde(cmd: str, desc: str, cmd_type: str):
parser = subparsers.add_parser(cmd, description=desc)
parser.add_argument(
"host",
choices=["linux", "linux_arm64", "mac", "windows", "windows_arm64", "all_os"],
help="host os name",
)
parser.add_argument(
"qt_version_spec",
metavar="(VERSION | SPECIFICATION)",
help='Qt version in the format of "5.X.Y" or SimpleSpec like "5.X" or "<6.X"',
)
parser.set_defaults(func=lambda args: self.run_list_src_doc_examples(args, cmd_type))
if cmd_type != "src":
parser.add_argument("-m", "--modules", action="store_true", help="Print list of available modules")
# Create install command parsers
make_parser_it("install-qt", "Install Qt.", self._set_install_qt_parser, argparse.RawTextHelpFormatter)
make_parser_it("install-tool", "Install tools.", self._set_install_tool_parser, None)
make_parser_it(
"install-qt-official",
"Install Qt with official installer.",
self._set_install_qt_commercial_parser,
argparse.RawTextHelpFormatter,
)
make_parser_it(
"list-qt-official",
"Search packages using Qt official installer.",
self._set_list_qt_commercial_parser,
argparse.RawTextHelpFormatter,
)
make_parser_sde("install-doc", "Install documentation.", self.run_install_doc, False)
make_parser_sde("install-example", "Install examples.", self.run_install_example, False)
make_parser_sde("install-src", "Install source.", self.run_install_src, True, is_add_modules=False)
# Create list command parsers
self._make_list_qt_parser(subparsers)
self._make_list_tool_parser(subparsers)
make_parser_list_sde("list-doc", "List documentation archives available (use with install-doc)", "doc")
make_parser_list_sde("list-example", "List example archives available (use with install-example)", "examples")
make_parser_list_sde("list-src", "List source archives available (use with install-src)", "src")
self._make_common_parsers(subparsers)
def _make_list_qt_parser(self, subparsers: argparse._SubParsersAction):
"""Creates a subparser that works with the MetadataFactory, and adds it to the `subparsers` parameter"""
list_parser: ListArgumentParser = subparsers.add_parser(
"list-qt",
formatter_class=argparse.RawDescriptionHelpFormatter,
epilog="Examples:\n"
"$ aqt list-qt mac # print all targets for Mac OS\n"
"$ aqt list-qt mac desktop # print all versions of Qt 5\n"
'$ aqt list-qt mac desktop --spec "5.9" # print all versions of Qt 5.9\n'
'$ aqt list-qt mac desktop --spec "5.9" --latest-version # print latest Qt 5.9\n'
"$ aqt list-qt mac desktop --modules 5.12.0 clang_64 # print modules for 5.12.0\n"
"$ aqt list-qt mac desktop --spec 5.9 --modules latest clang_64 # print modules for latest 5.9\n"
"$ aqt list-qt mac desktop --arch 5.9.9 # print architectures for "
"5.9.9/mac/desktop\n"
"$ aqt list-qt mac desktop --arch latest # print architectures for the "
"latest Qt 5\n"
"$ aqt list-qt mac desktop --archives 5.9.0 clang_64 # list archives in base Qt "
"installation\n"
"$ aqt list-qt mac desktop --archives 5.14.0 clang_64 debug_info # list archives in debug_info "
"module\n"
"$ aqt list-qt all_os wasm --arch 6.8.1 # print architectures for Qt WASM "
"6.8.1\n",
)
list_parser.add_argument(
"host",
choices=["linux", "linux_arm64", "mac", "windows", "windows_arm64", "all_os"],
help="host os name",
)
list_parser.add_argument(
"target",
nargs="?",
default=None,
choices=["desktop", "winrt", "android", "ios", "wasm", "qt"],
help="Target SDK. When omitted, this prints all the targets available for a host OS.",
)
list_parser.add_argument(
"--extension",
choices=ArchiveId.ALL_EXTENSIONS,
help="Deprecated since aqt v3.1.0. Use of this flag will emit a warning, but will otherwise be ignored.",
)
list_parser.add_argument(
"--spec",
type=str,
metavar="SPECIFICATION",
help="Filter output so that only versions that match the specification are printed. "
'IE: `aqt list-qt windows desktop --spec "5.12"` prints all versions beginning with 5.12',
)
list_parser.add_argument(
"--use-official-installer",
nargs="*",
default=None,
metavar=("EMAIL", "PASSWORD"),
help="Use the official Qt installer for research instead of the aqt researcher. "
"Can be used without arguments or with email and password: --use-official-installer email password. "
"This redirects to list-qt-official. "
"Arguments not compatible with the official installer will be ignored.",
)
output_modifier_exclusive_group = list_parser.add_mutually_exclusive_group()
output_modifier_exclusive_group.add_argument(
"--modules",
type=str,
nargs=2,
metavar=("(VERSION | latest)", "ARCHITECTURE"),
help='First arg: Qt version in the format of "5.X.Y", or the keyword "latest". '
'Second arg: an architecture, which may be printed with the "--arch" flag. '
"When set, this prints all the modules available for either Qt 5.X.Y or the latest version of Qt.",
)
output_modifier_exclusive_group.add_argument(
"--long-modules",
type=str,
nargs=2,
metavar=("(VERSION | latest)", "ARCHITECTURE"),
help='First arg: Qt version in the format of "5.X.Y", or the keyword "latest". '
'Second arg: an architecture, which may be printed with the "--arch" flag. '
"When set, this prints a table that describes all the modules available "
"for either Qt 5.X.Y or the latest version of Qt.",
)
output_modifier_exclusive_group.add_argument(
"--extensions",
type=str,
metavar="(VERSION | latest)",
help="Deprecated since v3.1.0. Prints a list of valid arguments for the '--extension' flag. "
"Since the '--extension' flag is now deprecated, this will always print an empty list.",
)
output_modifier_exclusive_group.add_argument(
"--arch",
type=str,
metavar="(VERSION | latest)",
help='Qt version in the format of "5.X.Y", or the keyword "latest". '
"When set, this prints all architectures available for either Qt 5.X.Y or the latest version of Qt.",
)
output_modifier_exclusive_group.add_argument(
"--latest-version",
action="store_true",
help="print only the newest version available",
)
output_modifier_exclusive_group.add_argument(
"--archives",
type=str,
nargs="+",
help="print the archives available for Qt base or modules. "
"If two arguments are provided, the first two arguments must be 'VERSION | latest' and "
"'ARCHITECTURE', and this command will print all archives associated with the base Qt package. "
"If more than two arguments are provided, the remaining arguments will be interpreted as modules, "
"and this command will print all archives associated with those modules. "
"At least two arguments are required.",
)
list_parser.set_defaults(func=self.run_list_qt)
def _make_list_tool_parser(self, subparsers: argparse._SubParsersAction):
"""Creates a subparser that works with the MetadataFactory, and adds it to the `subparsers` parameter"""
list_parser: ListArgumentParser = subparsers.add_parser(
"list-tool",
formatter_class=argparse.RawDescriptionHelpFormatter,
epilog="Examples:\n"
"$ aqt list-tool mac desktop # print all tools for mac desktop\n"
"$ aqt list-tool mac desktop tools_ifw # print all tool variant names for QtIFW\n"
"$ aqt list-tool mac desktop ifw # print all tool variant names for QtIFW\n"
"$ aqt list-tool mac desktop tools_ifw --long # print tool variant names with metadata for QtIFW\n"
"$ aqt list-tool mac desktop ifw --long # print tool variant names with metadata for QtIFW\n",
)
list_parser.add_argument(
"host",
choices=["linux", "linux_arm64", "mac", "windows", "windows_arm64", "all_os"],
help="host os name",
)
list_parser.add_argument(
"target",
nargs="?",
default=None,
choices=["desktop", "winrt", "android", "ios", "wasm", "qt"],
help="Target SDK. When omitted, this prints all the targets available for a host OS.",
)
list_parser.add_argument(
"tool_name",
nargs="?",
default=None,
help='Name of a tool, ie "tools_mingw" or "tools_ifw". '
"When omitted, this prints all the tool names available for a host OS/target SDK combination. "
"When present, this prints all the tool variant names available for this tool. ",
)
list_parser.add_argument(
"-l",
"--long",
action="store_true",
help="Long display: shows a table of metadata associated with each tool variant. "
"On narrow terminals, it displays tool variant names, versions, and release dates. "
"On terminals wider than 95 characters, it also displays descriptions of each tool.",
)
list_parser.set_defaults(func=self.run_list_tool)
def _make_common_parsers(self, subparsers: argparse._SubParsersAction) -> None:
help_parser = subparsers.add_parser("help")
help_parser.set_defaults(func=self.show_help)
version_parser = subparsers.add_parser("version")
version_parser.set_defaults(func=self.show_aqt_version)
def _set_common_options(self, subparser: argparse.ArgumentParser) -> None:
subparser.add_argument(
"-O",
"--outputdir",
nargs="?",
help="Target output directory(default current directory)",
)
subparser.add_argument(
"-b",
"--base",
nargs="?",
help="Specify mirror base url such as http://mirrors.ocf.berkeley.edu/qt/, " "where 'online' folder exist.",
)
subparser.add_argument(
"--timeout",
nargs="?",
type=float,
help="Specify connection timeout for download site.(default: 5 sec)",
)
subparser.add_argument("-E", "--external", nargs="?", help="Specify external 7zip command path.")
subparser.add_argument("--internal", action="store_true", help="Use internal extractor.")
subparser.add_argument(
"-k",
"--keep",
action="store_true",
help="Keep downloaded archive when specified, otherwise remove after install",
)
subparser.add_argument(
"-d",
"--archive-dest",
type=str,
default=None,
help="Set the destination path for downloaded archives (temp directory by default).",
)
subparser.add_argument(
"--dry-run",
action="store_true",
help="Print what would be downloaded and installed without actually doing it",
)
subparser.add_argument(
"--UNSAFE-ignore-hash",
action="store_true",
help="UNSAFE: Skip hash verification of downloaded files. Use at your own risk.",
)
def _set_module_options(self, subparser):
subparser.add_argument("-m", "--modules", nargs="*", help="Specify extra modules to install")
def _set_archive_options(self, subparser):
subparser.add_argument(
"--archives",
nargs="*",
help="Specify subset of archives to install. Affects the base module and the debug_info module. "
"(Default: all archives).",
)
def _set_common_arguments(self, subparser, *, is_target_deprecated: bool = False):
"""
install-src/doc/example commands do not require a "target" argument anymore, as of 11/22/2021
"""
subparser.add_argument(
"host",
choices=["linux", "linux_arm64", "mac", "windows", "windows_arm64", "all_os"],
help="host os name",
)
if is_target_deprecated:
subparser.add_argument(
"target",
choices=["desktop", "winrt", "android", "ios", "wasm", "qt"],
nargs="?",
help="Ignored. This parameter is deprecated and marked for removal in a future release. "
"It is present here for backwards compatibility.",
)
else:
subparser.add_argument(
"target",
choices=["desktop", "winrt", "android", "ios", "wasm", "qt"],
help="target sdk",
)
subparser.add_argument(
"qt_version_spec",
metavar="(VERSION | SPECIFICATION)",
help='Qt version in the format of "5.X.Y" or SimpleSpec like "5.X" or "<6.X"',
)
def _setup_settings(self, args=None):
# setup logging
setup_logging()
self.logger = getLogger("aqt.main")
# setup settings
if args is not None and args.config is not None:
Settings.load_settings(args.config)
else:
config = os.getenv("AQT_CONFIG", None)
if config is not None and os.path.exists(config):
Settings.load_settings(config)
self.logger.debug("Load configuration from {}".format(config))
else:
Settings.load_settings()
# Set ignore_hash to True if --UNSAFE-ignore-hash flag was passed
if args is not None and hasattr(args, "UNSAFE_ignore_hash") and args.UNSAFE_ignore_hash:
self.logger.warning(
"************************************************************************************************"
)
self.logger.warning(
"Hash verification is disabled. This is UNSAFE and may allow malicious files to be downloaded."
)
self.logger.warning(
"If your install mirror hosts malicious files, you won't be able to know. Use at your own risk."
)
self.logger.warning(
"************************************************************************************************"
)
Settings.set_ignore_hash_for_session(True)
@staticmethod
def _validate_version_str(
version_str: Optional[str],
*,
allow_latest: bool = False,
allow_empty: bool = False,
allow_minus: bool = False,
) -> None:
"""
Raise CliInputError if the version is not an acceptable Version.
:param version_str: The version string to check.
:param allow_latest: If true, the string "latest" is acceptable.
:param allow_empty: If true, the empty string is acceptable.
:param allow_minus: If true, everything after the first '-' in the version will be ignored.
This allows acceptance of versions like "1.2.3-0-202101020304"
"""
if allow_latest and version_str == "latest":
return
if not version_str:
if allow_empty:
return
else:
raise CliInputError("Invalid empty version! Please use the form '5.X.Y'.")
try:
if "-" in version_str and allow_minus:
version_str = version_str[: version_str.find("-")]
Version(version_str)
except ValueError as e:
raise CliInputError(f"Invalid version: '{version_str}'! Please use the form '5.X.Y'.") from e
def _get_autodesktop_dir_and_arch(
self,
should_autoinstall: bool,
host: str,
target: str,
base_path: Path,
version: Version,
arch: str,
) -> Tuple[Optional[str], Optional[str]]:
"""Returns expected_desktop_arch_dir, desktop_arch_to_install"""
is_wasm = arch.startswith("wasm")
is_msvc = "msvc" in arch
is_win_desktop_msvc_arm64 = (
host == "windows" and target == "desktop" and is_msvc and arch.endswith(("arm64", "arm64_cross_compiled"))
)
if version < Version("6.0.0") or (
target not in ["ios", "android", "wasm"] and not is_wasm and not is_win_desktop_msvc_arm64
):
# We only need to worry about the desktop directory for Qt6 mobile or wasm installs.
return None, None
# For WASM installations on all_os, we need to choose a default desktop host
host = Cli._get_effective_os_name(host)
installed_desktop_arch_dir = QtRepoProperty.find_installed_desktop_qt_dir(host, base_path, version, is_msvc=is_msvc)
if installed_desktop_arch_dir:
# An acceptable desktop Qt is already installed, so don't do anything.
self.logger.info(f"Found installed {host}-desktop Qt at {installed_desktop_arch_dir}")
return installed_desktop_arch_dir.name, None
try:
default_desktop_arch = MetadataFactory(ArchiveId("qt", host, "desktop")).fetch_default_desktop_arch(
version, is_msvc
)
except ValueError as e:
if "Target 'desktop' is invalid" in str(e):
# Special case for all_os host which doesn't support desktop target
return None, None
raise
desktop_arch_dir = QtRepoProperty.get_arch_dir_name(host, default_desktop_arch, version)
expected_desktop_arch_path = base_path / dir_for_version(version) / desktop_arch_dir
if is_win_desktop_msvc_arm64:
qt_type = "MSVC Arm64"
elif is_wasm:
qt_type = "Qt6-WASM"
else:
qt_type = target
if should_autoinstall:
# No desktop Qt is installed, but the user has requested installation. Find out what to install.
self.logger.info(f"You are installing the {qt_type} version of Qt")
return expected_desktop_arch_path.name, default_desktop_arch
else:
self.logger.warning(
f"You are installing the {qt_type} version of Qt, which requires that the desktop version of Qt "
f"is also installed. You can install it with the following command:\n"
f" `aqt install-qt {host} desktop {version} {default_desktop_arch}`"
)
return expected_desktop_arch_path.name, None
@staticmethod
def _get_effective_os_name(host: str) -> str:
if host != "all_os":
return host
elif sys.platform.startswith("linux"):
return "linux"
elif sys.platform == "darwin":
return "mac"
else:
return "windows"
def is_64bit() -> bool:
"""check if running platform is 64bit python."""
return sys.maxsize > 1 << 32
def run_installer(
archives: List[QtPackage],
base_dir: str,
sevenzip: Optional[str],
keep: bool,
archive_dest: Path,
dry_run: bool = False,
):
if dry_run:
logger = getLogger("aqt.installer")
logger.info("DRY RUN: Would download and install the following:")
for arc in archives:
line_parts = [f" - {arc.name}: {arc.archive_path}"]
if hasattr(arc, "package_desc") and arc.package_desc:
size_match = re.search(r"Size: ([^,]+)", arc.package_desc)
if size_match:
line_parts.append(f" ({size_match.group(1)})")
if arc.archive_install_path and arc.archive_install_path.strip():
line_parts.append(f" -> {arc.archive_install_path}")
logger.info("".join(line_parts))
logger.info(f"Total packages: {len(archives)}")
return
queue = multiprocessing.Manager().Queue(-1)
listener = MyQueueListener(queue)
listener.start()
#
tasks = []
for arc in archives:
tasks.append((arc, base_dir, sevenzip, queue, archive_dest, Settings.configfile, keep))
ctx = multiprocessing.get_context("spawn")
if is_64bit():
pool = ctx.Pool(Settings.concurrency, init_worker_sh, (), 4)
else:
pool = ctx.Pool(Settings.concurrency, init_worker_sh, (), 1)
def close_worker_pool_on_exception(exception: BaseException):
logger = getLogger("aqt.installer")
logger.warning(f"Caught {exception.__class__.__name__}, terminating installer workers")
pool.terminate()
pool.join()
try:
pool.starmap(installer, tasks)
pool.close()
pool.join()
except PermissionError as e: # subclass of OSError
close_worker_pool_on_exception(e)
raise DiskAccessNotPermitted(
f"Failed to write to base directory at {base_dir}",
suggested_action=[
"Check that the destination is writable and does not already contain files owned by another user."
],
) from e
except OSError as e:
close_worker_pool_on_exception(e)
if e.errno == errno.ENOSPC:
raise OutOfDiskSpace(
"Insufficient disk space to complete installation.",
suggested_action=[
"Check available disk space.",
"Check size requirements for installation.",
],
) from e
else:
raise
except KeyboardInterrupt as e:
close_worker_pool_on_exception(e)
raise CliKeyboardInterrupt("Installer halted by keyboard interrupt.") from e
except MemoryError as e:
close_worker_pool_on_exception(e)
alt_extractor_msg = (
"Please try using the '--external' flag to specify an alternate 7z extraction tool "
"(see https://aqtinstall.readthedocs.io/en/latest/cli.html#cmdoption-list-tool-external)"
)
if Settings.concurrency > 1:
docs_url = "https://aqtinstall.readthedocs.io/en/stable/configuration.html#configuration"
raise OutOfMemory(
"Out of memory when downloading and extracting archives in parallel.",
suggested_action=[
f"Please reduce your 'concurrency' setting (see {docs_url})",
alt_extractor_msg,
],
) from e
raise OutOfMemory(
"Out of memory when downloading and extracting archives.",
suggested_action=["Please free up more memory.", alt_extractor_msg],
)
except Exception as e:
close_worker_pool_on_exception(e)
raise e from e
finally:
# all done, close logging service for sub-processes
listener.enqueue_sentinel()
listener.stop()
def init_worker_sh() -> None:
"""Initialize worker signal handling"""
signal.signal(signal.SIGINT, signal.SIG_IGN)
def installer(
qt_package: QtPackage,
base_dir: str,
command: Optional[str],
queue: multiprocessing.Queue,
archive_dest: Path,
settings_ini: str,
keep: bool,
) -> None:
"""
Installer function to download archive files and extract it.
It is called through multiprocessing.Pool()
"""
name = qt_package.name
base_url = qt_package.base_url
archive: Path = archive_dest / qt_package.archive
base_dir = posixpath.join(base_dir, qt_package.archive_install_path)
start_time = time.perf_counter()
Settings.load_settings(file=settings_ini)
# setup queue logger
setup_logging()
qh = QueueHandler(queue)
logger = getLogger()
for handler in logger.handlers:
handler.close()
logger.removeHandler(handler)
logger.addHandler(qh)
#
timeout = (Settings.connection_timeout, Settings.response_timeout)
hash = get_hash(qt_package.archive_path, Settings.hash_algorithm, timeout) if not Settings.ignore_hash else None
def download_bin(_base_url):
url = posixpath.join(_base_url, qt_package.archive_path)
logger.debug("Download URL: {}".format(url))
return downloadBinaryFile(url, archive, Settings.hash_algorithm, hash, timeout)
retry_on_errors(
action=lambda: retry_on_bad_connection(download_bin, base_url),
acceptable_errors=(ArchiveChecksumError,),
num_retries=Settings.max_retries_on_checksum_error,
name=f"Downloading {name}",
)
gc.collect()
if tarfile.is_tarfile(archive):
with tarfile.open(archive) as tar_archive:
if hasattr(tarfile, "data_filter"):
tar_archive.extractall(filter="tar", path=base_dir)
else:
# remove this when the minimum Python version is 3.12
logger.warning("Extracting may be unsafe; consider updating Python to 3.11.4 or greater")
tar_archive.extractall(path=base_dir)
elif zipfile.is_zipfile(archive):
with zipfile.ZipFile(archive) as zip_archive:
zip_archive.extractall(path=base_dir)
elif command is None:
with py7zr.SevenZipFile(archive, "r") as szf:
szf.extractall(path=base_dir)
else:
command_args = [command, "x", "-aoa", "-bd", "-y", "-o{}".format(base_dir), str(archive)]
try:
proc = subprocess.run(command_args, stdout=subprocess.PIPE, check=True)
logger.debug(proc.stdout)
except subprocess.CalledProcessError as cpe:
msg = "\n".join(filter(None, [f"Extraction error: {cpe.returncode}", cpe.stdout, cpe.stderr]))
raise ArchiveExtractionError(msg) from cpe
if not keep:
os.unlink(archive)
logger.info("Finished installation of {} in {:.8f}".format(archive.name, time.perf_counter() - start_time))
gc.collect()
qh.flush()
qh.close()
logger.removeHandler(qh)
|