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
|
# Copyright (C) 2024 The Qt Company Ltd.
# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
import argparse
import subprocess
import os
import sys
import time
from multiprocessing import Pool, cpu_count
from pathlib import Path
def run_qdoc(file, qdoc_args, args):
env = os.environ
env["BUILDDIR"] = args.build_dir
env["QT_INSTALL_DOCS"] = args.qt_install_docs
env["QT_VERSION"] = args.qt_version
env["QT_VER"] = ".".join(args.qt_version.split(".")[:2])
env["QT_VERSION_TAG"] = args.qt_version
command = [
args.qdoc_bin,
file,
*qdoc_args,
"-installdir",
args.doc_data_dir,
"-outputdir",
args.doc_data_dir,
]
start_time = time.time()
_ = subprocess.Popen(command, env=env, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
out, err = _.communicate()
returncode = _.wait()
duration = round(time.time() - start_time)
if args.verbose or returncode != 0 or err:
cmd_str = " ".join(command)
print(f"> Output of: {cmd_str}")
if out:
print(out.decode("utf-8"), file=sys.stdout)
if err:
print(err.decode("utf-8"), file=sys.stderr)
print(f"> Finished: {file} {duration}s (exit code {returncode})")
if returncode != 0:
raise Exception(f"Failing executing the command {command} ({returncode})")
def get_qdocconf_files():
if not Path("pyside.qdocconf").exists():
print("ERROR: the working dir doesn't include a 'pyside.qdocconf' file")
sys.exit(-1)
# Generate the temporary qdocconf files
# This is necessary because using a file like 'pyside-qtcore.qtdocconf'
# will generate an error, because inside we call functions like 'include()'
files_single_exec = []
files_prepare = []
with open("pyside.qdocconf") as f:
for i in f.read().splitlines():
_p = Path(i)
_name = f"_{_p.stem}.qdocconf"
with open(_name, "w", encoding="utf-8") as f:
f.write(i)
files_single_exec.append(_name)
files_prepare.append(i.strip())
return files_prepare, files_single_exec
if __name__ == "__main__":
parser = argparse.ArgumentParser(prog="qdoc spawner")
parser.add_argument("--qt", dest="qt_version", action="store", required=True)
parser.add_argument("--doc-data-dir", dest="doc_data_dir", action="store", required=True)
parser.add_argument("--qdoc-binary", dest="qdoc_bin", action="store", required=True)
parser.add_argument("--build-dir", dest="build_dir", action="store", required=True)
parser.add_argument("--qt-install-docs", dest="qt_install_docs", action="store", required=True)
parser.add_argument("--parallel", dest="parallel", action="store", default="4")
parser.add_argument("--verbose", dest="verbose", action="store_true", default=False)
args = parser.parse_args()
core_index = Path(args.doc_data_dir) / "webxml" / "qtcore-index.webxml"
if core_index.is_file():
print(f"qdoc_spawner: {core_index} already exists, bailing out")
sys.exit(0)
files_prepare, files_single_exec = get_qdocconf_files()
parallel = args.parallel
if parallel == "auto":
parallel = cpu_count()
try:
# mode: -prepare -no-link-errors
with Pool(int(parallel)) as p:
p.starmap(run_qdoc, [(str(f), ["-prepare", "-no-link-errors"], args) for f in files_prepare])
# mode: -single-exec
with Pool(int(parallel)) as p:
p.starmap(run_qdoc, [(str(f), ["-single-exec"], args) for f in files_single_exec])
except Exception as e:
print(f"qdoc_spawner: error: {e}", file=sys.stderr)
sys.exit(-1)
|
