001 Documentation App

 1import re
 2import sys
 3
 4from PyQt5.QtCore import pyqtSignal, pyqtSlot, QUrl, Qt
 5from PyQt5.QtWebEngineWidgets import QWebEngineView
 6from PyQt5.QtWidgets import QTreeWidgetItem, QWidget, QVBoxLayout, QLineEdit, QTreeWidget, QTreeWidgetItemIterator, \
 7    QApplication, QMainWindow, QDockWidget
 8import PyQt5
 9import glob
10import importlib

1def str_to_class(name, module="PyQt5"):
2    package_name, module_name = name.split(".")
3    return getattr(sys.modules[module + "." + package_name], module_name)

 1def pyi_file_names(pyqt5_root):
 2    return glob.glob(f"{pyqt5_root}/*.pyi")
 3
 4def root_object_names(pyqt5_root=PyQt5.__path__[0], class_fingerprint="^class ([^\(\)]*)\(sip.wrapper\):$"):
 5    files = pyi_file_names(pyqt5_root)
 6    names = []
 7    for f in files:
 8        module = f.split("\\")[-1].split(".")[0]
 9        if module.startswith("Qt"):
10            importlib.import_module(f"PyQt5.{module}")
11            with open(f) as fid:
12                for line in fid:
13                    ret = re.match(class_fingerprint, line)
14                    if ret is None:
15                        continue
16                    captures = ret.groups()
17                    if len(captures) > 0:
18                        names.append(module + "." + captures[0])
19
20    return [str_to_class(n) for n in sorted(names)]

1def walk_to_QTreeWdigetItem(self: object, parent: QTreeWidgetItem = None):
2    sc = self.__subclasses__()
3    item = QTreeWidgetItem(parent)
4    item.setText(0, self.__name__)
5    item.setText(1, f"{len(self.__dict__)}")
6    item.setExpanded(True)
7    for c in sc:
8        walk_to_QTreeWdigetItem(c, item)
9    return item

 1class TreeWithSearch(QWidget):
 2    selectItem = pyqtSignal(str)
 3
 4    def __init__(self, parent=None, classes=None):
 5        super(TreeWithSearch, self).__init__(parent=parent)
 6        self.layout = QVBoxLayout(self)
 7        self.searchBox = QLineEdit()
 8        self.classes = QTreeWidget()
 9        self.layout.addWidget(self.searchBox)
10        self.layout.addWidget(self.classes)
11        self.setLayout(self.layout)
12
13        self.searchBox.setPlaceholderText("type class name")
14
15        if classes is None:
16            classes = root_object_names()
17            classes.extend(root_object_names(class_fingerprint="^class ([^\(\)]*)\(PyQt5.sipsimplewrapper\):$"))
18
19
20            classes.sort(key=lambda iClass: iClass.__name__)
21
22        for i, c in enumerate(classes):
23            root = walk_to_QTreeWdigetItem(c)
24            self.classes.addTopLevelItem(root)
25
26        self.classes.setHeaderLabels(["name", "funcs"])
27        self.classes.setColumnHidden(1, True)
28        self.classes.setHeaderHidden(True)
29
30        self.classes.clicked.connect(
31            lambda index:
32            self.selectItem.emit(self.classes.itemFromIndex(index).text(0))
33        )
34
35        self.searchBox.textChanged.connect(self._textChanged)

 1    @pyqtSlot(str)
 2    def _textChanged(self, name: str):
 3        # collapse parent nodes
 4        if name.isspace():
 5            iterator = QTreeWidgetItemIterator(self.classes, QTreeWidgetItemIterator.HasChildren)
 6            while (item := iterator.value()) is not None:
 7                item: QTreeWidgetItem
 8                item.setExpanded(False)
 9                iterator += 1
10            return
11
12        iterator = QTreeWidgetItemIterator(self.classes, QTreeWidgetItemIterator.All)
13        while (item := iterator.value()) is not None:
14            item: QTreeWidgetItem
15            class_name: str = item.text(0).lower()
16            is_show = name.strip().lower() in class_name
17            item.setHidden(not is_show)
18            # toggle to show and expand all its ancestors
19            if is_show:
20                p = item
21                while p := p.parent():
22                    p.setHidden(False)
23                    p.setExpanded(True)
24            iterator += 1

 1class QtHelpView(QWebEngineView):
 2
 3    def __init__(self, parent=None):
 4        super(QtHelpView, self).__init__(parent)
 5        self.base_url = "https://doc.qt.io/qt-5"
 6        self.load(QUrl(self.base_url))
 7
 8    @pyqtSlot(str)
 9    def show_class(self, name):
10        self.load(QUrl(f"{self.base_url}/{name.lower()}.html"))

 1if __name__ == '__main__':
 2    app = QApplication([])
 3
 4    main_window = QMainWindow()
 5
 6    tree = TreeWithSearch(main_window)
 7
 8    dock = QDockWidget()
 9    dock.setWidget(tree)
10
11    main_window.addDockWidget(Qt.LeftDockWidgetArea, dock)
12
13    # pip install PyQtWebEngine
14    view = QtHelpView(main_window)
15    tree.selectItem.connect(view.show_class)
16
17    main_window.setCentralWidget(view)
18
19    main_window.resize(1440, 900)
20    main_window.show()
21    sys.exit(app.exec_())

1pip install PyQt5 PyQtWebEngine

1python pyqt5help.py