From fb4e3722bb2ba1ba38a4d1eb581d426e1156fb33 Mon Sep 17 00:00:00 2001 From: Florian Bruhin Date: Mon, 26 Jun 2023 00:01:25 +0200 Subject: qt 6: Document purpose of wrappers --- qutebrowser/qt/machinery.py | 10 ++++++++++ 1 file changed, 10 insertions(+) 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), -- cgit v1.2.3-54-g00ecf