hookutils: qt: look for commercial pyqt to determine layout

lv-develer · bwoodsend · commit 330ab13bb5e2 · 2023-08-26T12:18:37.000+01:00
Commercial PyQt wheels install with the "_commercial" suffix as their
package name but still make the regular PyQt5/PyQt6 namespace packages
available.

This leads the layout detection logic to assume the old layout because
is_module_satisfies() enters a fallback code path where it looks for the
__version__ attribute inside the namespace package, which doesn't exist.

A possible solution is to look for package names with the "_commercial"
suffix when the standard lookup fails. The _use_new_layout utility
method was introduced to perform such checks and is then used in both
PyQt5 and PyQt6 code paths.
diff --git a/PyInstaller/utils/hooks/qt/__init__.py b/PyInstaller/utils/hooks/qt/__init__.py
@@ -121,33 +121,12 @@ def __init__(self, namespace):
         # Windows, or with Qt and PyQt5 installed on linux using native package manager), and in those, the Qt
         # PrefixPath does not reflect the required relative target path for the frozen application.
         if namespace == 'PyQt5':
-            # PyQt5 uses PyQt5/Qt on all platforms, or PyQt5/Qt5 from version 5.15.4 on
-            try:
-                # The call below might fail with AttributeError on some PyQt5 versions (e.g., 5.9.2 from conda's main
-                # channel); missing dist information forces a fallback codepath that tries to check for __version__
-                # attribute that does not exist, either. So handle the error gracefully and assume old layout.
-                new_layout = hooks.is_module_satisfies("PyQt5 >= 5.15.4")
-            except AttributeError:
-                new_layout = False
-            if new_layout:
+            if self._use_new_layout("PyQt5", "5.15.4", False):
                 self.qt_rel_dir = os.path.join('PyQt5', 'Qt5')
             else:
                 self.qt_rel_dir = os.path.join('PyQt5', 'Qt')
         elif namespace == 'PyQt6':
-            # Similarly to PyQt5, PyQt6 switched from PyQt6/Qt to PyQt6/Qt6 in 6.0.3
-            try:
-                # The call below might fail with AttributeError in case of a partial PyQt6 installation. For example,
-                # user installs PyQt6 via pip, which also installs PyQt6-Qt6 and PyQt6-sip. Then they naively uninstall
-                # PyQt6 package, which leaves the other two behind. PyQt6 now becomes a namespace package and there is
-                # no dist metadata, so a fallback codepath in is_module_satisfies tries to check for __version__
-                # attribute that does not exist, either. Handle such errors gracefully and assume new layout (with
-                # PyQt6, the new layout is more likely); it does not really matter what layout we assume, as library is
-                # not usable anyway, but we do need to be able to return an instance of QtLibraryInfo with "version"
-                # attribute set to a falsey value.
-                new_layout = hooks.is_module_satisfies("PyQt6 >= 6.0.3")
-            except AttributeError:
-                new_layout = True
-            if new_layout:
+            if self._use_new_layout("PyQt6", "6.0.3", True):
                 self.qt_rel_dir = os.path.join('PyQt6', 'Qt6')
             else:
                 self.qt_rel_dir = os.path.join('PyQt6', 'Qt')
@@ -181,6 +160,31 @@ def __getattr__(self, name):
         # ... and return the requested attribute
         return getattr(self, name)
 
+    # Check whether we must use the new layout (e.g. PyQt5/Qt5, PyQt6/Qt6) instead of the old layout (PyQt5/Qt,
+    # PyQt6/Qt).
+    @staticmethod
+    def _use_new_layout(package_basename: str, version: str, fallback_value: bool) -> bool:
+        # The call to is_module_satisfies might fail with AttributeError in case of a partial installation, or when dist
+        # information is missing, in which case a fallback codepath tries to check for a __version__ attribute that does
+        # not exist.
+        #
+        # This may happen for the following (not exhaustive) reasons:
+        #
+        # - PyQt 5.9.2 installed from conda's main channel.
+        # - User installs PyQt6 via pip, which also installs PyQt6-Qt6 and PyQt6-sip. Then they naively uninstall PyQt6
+        #   package, which leaves the other two behind. PyQt6 now becomes a namespace package and there is no dist
+        #   metadata.
+        # - The PyQt5 commercial wheel is installed. It creates the PyQt5 namespace package but dist information is
+        #   available under PyQt5_commercial. Since we first check for the non-commercial wheel, we trip the fallback
+        #   codepath inside is_module_satisfies.
+        try:
+            return hooks.is_module_satisfies(f"{package_basename} >= {version}")
+        except AttributeError:
+            try:
+                return hooks.is_module_satisfies(f"{package_basename}_commercial >= {version}")
+            except AttributeError:
+                return fallback_value
+
     # Load Qt information (called on first access to related fields)
     def _load_qt_info(self):
         """
diff --git a/news/7770.hooks.rst b/news/7770.hooks.rst
@@ -0,0 +1 @@
+Add support for commercial PyQt5 and PyQt6 wheels.

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Add support for commercial PyQt5 and PyQt6 wheels.`