summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFlorian Bruhin <me@the-compiler.org>2023-06-26 00:01:25 +0200
committerFlorian Bruhin <me@the-compiler.org>2023-06-30 19:29:28 +0200
commitfb4e3722bb2ba1ba38a4d1eb581d426e1156fb33 (patch)
tree5c328cc8e331b9b7f15408359e7e284f4b7cb0f9
parent7a2cee44b18a7233975177c1416877aabd21ef21 (diff)
downloadqutebrowser-fb4e3722bb2ba1ba38a4d1eb581d426e1156fb33.tar.gz
qutebrowser-fb4e3722bb2ba1ba38a4d1eb581d426e1156fb33.zip
qt 6: Document purpose of wrappers
-rw-r--r--qutebrowser/qt/machinery.py10
1 files changed, 10 insertions, 0 deletions
diff --git a/qutebrowser/qt/machinery.py b/qutebrowser/qt/machinery.py
index c737fa96f..39d8661bf 100644
--- a/qutebrowser/qt/machinery.py
+++ b/qutebrowser/qt/machinery.py
@@ -3,6 +3,16 @@
"""Qt wrapper selection.
Contains selection logic and globals for Qt wrapper selection.
+
+All other files in this package are intended to be simple wrappers around Qt imports.
+Depending on what is set in this module, they import from PyQt5 or PyQt6.
+
+The import wrappers are intended to be as thin as possible. They will not unify
+API-level differences between Qt 5 and Qt 6. This is best handled by the calling code,
+which has a better picture of what changed between APIs and how to best handle it.
+
+What they *will* do is handle simple 1:1 renames of classes, or moves between
+modules (where they aim to always expose the Qt 6 API). See e.g. webenginecore.py.
"""
# NOTE: No qutebrowser or PyQt import should be done here (at import time),