hooks: cleanup: port old hooks to PyInstaller.isolated

Replace uses of old `exec_statement()` and `eval_statement()`
hook utility functions with the `PyInstaller.isolated` framework
that has been available since PyInstaller 5.0.

In following hooks, the old `exec/eval_statement` was replaced with
equivalent isolated function:
- win32com
- wx.lib.activex
- enchant
- sentry_sdk
- ffpyplayer

In `OpenGL` hook, use standard `collect_submodules` hook utility
function to collect submodules of `OpenGL.arrays` instead of trying to
reinvent the wheel.

Remove the `gst._gst` hook, which was catering `pygst`, the python-2.7-era
GStreamer bindings.

Author: rokm

_pyinstaller_hooks_contrib/pre_safe_import_module/hook-win32com.py

@@ -10,7 +10,7 @@
 # SPDX-License-Identifier: GPL-2.0-or-later
 #-----------------------------------------------------------------------------
 """
-PyWin32 package 'win32com' extends it's __path__ attribute with win32comext
+PyWin32 package 'win32com' extends its __path__ attribute with win32comext
 directory and thus PyInstaller is not able to find modules in it. For example
 module 'win32com.shell' is in reality 'win32comext.shell'.
 
@@ -21,21 +21,25 @@
 
 import os
 
-from PyInstaller.utils.hooks import logger, exec_statement
-from PyInstaller.compat import is_win, is_cygwin
+from PyInstaller import compat
+from PyInstaller import isolated
+from PyInstaller.utils.hooks import logger
+
+
+@isolated.decorate
+def _get_win32com_file():
+    try:
+        import win32com
+        return win32com.__file__
+    except Exception:
+        return None
 
 
 def pre_safe_import_module(api):
-    if not (is_win or is_cygwin):
+    if not compat.is_win or compat.is_cygwin:
         return
-    win32com_file = exec_statement(
-        """
-        try:
-            from win32com import __file__
-            print(__file__)
-        except Exception:
-            pass
-        """).strip()
+
+    win32com_file = _get_win32com_file()
     if not win32com_file:
         logger.debug('win32com: module not available')
         return  # win32com unavailable

_pyinstaller_hooks_contrib/stdhooks/hook-OpenGL.py

@@ -17,30 +17,7 @@
 """
 
 from PyInstaller.compat import is_win, is_darwin
-from PyInstaller.utils.hooks import collect_data_files, exec_statement
-import os
-import glob
-
-
-def opengl_arrays_modules():
-    """
-    Return list of array modules for OpenGL module.
-    e.g. 'OpenGL.arrays.vbo'
-    """
-    statement = 'import OpenGL; print(OpenGL.__path__[0])'
-    opengl_mod_path = exec_statement(statement)
-    arrays_mod_path = os.path.join(opengl_mod_path, 'arrays')
-    files = glob.glob(arrays_mod_path + '/*.py')
-    modules = []
-
-    for f in files:
-        mod = os.path.splitext(os.path.basename(f))[0]
-        # Skip __init__ module.
-        if mod == '__init__':
-            continue
-        modules.append('OpenGL.arrays.' + mod)
-
-    return modules
+from PyInstaller.utils.hooks import collect_data_files, collect_submodules
 
 
 # PlatformPlugin performs a conditional import based on os.name and
@@ -54,7 +31,7 @@ def opengl_arrays_modules():
     hiddenimports = ['OpenGL.platform.glx']
 
 # Arrays modules are needed too.
-hiddenimports += opengl_arrays_modules()
+hiddenimports += collect_submodules('OpenGL.arrays')
 
 # PyOpenGL 3.x uses ctypes to load DLL libraries. PyOpenGL windows installer
 # adds necessary dll files to

_pyinstaller_hooks_contrib/stdhooks/hook-enchant.py

@@ -17,30 +17,32 @@
 
 import os
 
-from PyInstaller.compat import is_darwin
-from PyInstaller.utils.hooks import exec_statement, collect_data_files, \
-    collect_dynamic_libs, get_installer
+from PyInstaller import isolated
+from PyInstaller import compat
+from PyInstaller.utils.hooks import collect_data_files, collect_dynamic_libs, get_installer
 
 # TODO Add Linux support
 # Collect first all files that were installed directly into pyenchant
 # package directory and this includes:
 # - Windows: libenchat-1.dll, libenchat_ispell.dll, libenchant_myspell.dll, other
 #            dependent dlls and dictionaries for several languages (de, en, fr)
-# - Mac OS X: usually libenchant.dylib and several dictionaries when installed via pip.
+# - macOS: usually libenchant.dylib and several dictionaries when installed via pip.
 binaries = collect_dynamic_libs('enchant')
 datas = collect_data_files('enchant')
 excludedimports = ['enchant.tests']
 
-# On OS X try to find files from Homebrew or Macports environments.
-if is_darwin:
+# On macOS try to find files in Homebrew or Macports environments.
+if compat.is_darwin:
     # Note: env. var. ENCHANT_PREFIX_DIR is implemented only in the development version:
     #    https://github.com/AbiWord/enchant
     #    https://github.com/AbiWord/enchant/pull/2
     # TODO Test this hook with development version of enchant.
-    libenchant = exec_statement("""
-        from enchant._enchant import e
-        print(e._name)
-    """).strip()
+    @isolated.decorate
+    def _get_enchant_lib():
+        from enchant._enchant import e  # ctypes.CDLL
+        return e._name
+
+    libenchant = _get_enchant_lib()
 
     installer = get_installer('enchant')
     if installer != 'pip':
@@ -49,10 +51,12 @@
         binaries.append((libenchant, '.'))
 
         # Collect enchant backends from Macports. Using same file structure as on Windows.
-        backends = exec_statement("""
+        @isolated.decorate
+        def _get_enchant_backends():
             from enchant import Broker
-            for provider in Broker().describe():
-                print(provider.file)""").strip().split()
+            return [str(provider.file) for provider in Broker().describe()]
+
+        backends = _get_enchant_backends()
         binaries.extend([(b, 'enchant/lib/enchant') for b in backends])
 
         # Collect all available dictionaries from Macports. Using same file structure as on Windows.

_pyinstaller_hooks_contrib/stdhooks/hook-ffpyplayer.py

@@ -10,10 +10,19 @@
 # SPDX-License-Identifier: GPL-2.0-or-later
 # ------------------------------------------------------------------
 
-from PyInstaller.utils.hooks import eval_statement, collect_submodules
+from PyInstaller import isolated
+from PyInstaller.utils.hooks import collect_submodules
 
 hiddenimports = collect_submodules("ffpyplayer")
 binaries = []
-# ffpyplayer has an internal variable tells us where the libraries it was using
-for bin in eval_statement("import ffpyplayer; print(ffpyplayer.dep_bins)"):
-    binaries += [(bin, '.')]
+
+
+# ffpyplayer has an internal variable that list locations of libraries it is using.
+@isolated.decorate
+def _get_ffpyplayer_binary_dirs():
+    import ffpyplayer
+    return ffpyplayer.dep_bins
+
+
+for binary_dir in _get_ffpyplayer_binary_dirs():
+    binaries += [(binary_dir, '.')]  # Copy DLLs from these locations into top-level application directory.

_pyinstaller_hooks_contrib/stdhooks/hook-gst._gst.py

@@ -9,32 +9,31 @@
 #
 # SPDX-License-Identifier: GPL-2.0-or-later
 # ------------------------------------------------------------------
-import json
-from PyInstaller.utils.hooks import exec_statement
-
-hiddenimports = ["sentry_sdk.integrations.stdlib",
-                 "sentry_sdk.integrations.excepthook",
-                 "sentry_sdk.integrations.dedupe",
-                 "sentry_sdk.integrations.atexit",
-                 "sentry_sdk.integrations.modules",
-                 "sentry_sdk.integrations.argv",
-                 "sentry_sdk.integrations.logging",
-                 "sentry_sdk.integrations.threading"]
-
-statement = """
-import json
-import sentry_sdk.integrations as si
-
-integrations = []
-if hasattr(si, '_AUTO_ENABLING_INTEGRATIONS'):
+
+from PyInstaller import isolated
+
+hiddenimports = [
+    "sentry_sdk.integrations.stdlib",
+    "sentry_sdk.integrations.excepthook",
+    "sentry_sdk.integrations.dedupe",
+    "sentry_sdk.integrations.atexit",
+    "sentry_sdk.integrations.modules",
+    "sentry_sdk.integrations.argv",
+    "sentry_sdk.integrations.logging",
+    "sentry_sdk.integrations.threading",
+]
+
+
+@isolated.decorate
+def _get_integration_modules():
+    import sentry_sdk.integrations as si
+
     # _AUTO_ENABLING_INTEGRATIONS is a list of strings with default enabled integrations
     # https://github.com/getsentry/sentry-python/blob/c6b6f2086b58ffc674df5c25a600b8a615079fb5/sentry_sdk/integrations/__init__.py#L54-L66
+    integrations = getattr(si, '_AUTO_ENABLING_INTEGRATIONS', [])
 
-    def make_integration_name(integration_name: str):
-        return integration_name.rsplit(".", maxsplit=1)[0]
+    # The list contains fully-qualified class names; turn them into module names by removing the last component.
+    return [integration_name.rsplit('.', maxsplit=1)[0] for integration_name in integrations]
 
-    integrations.extend(map(make_integration_name, si._AUTO_ENABLING_INTEGRATIONS))
-print(json.dumps(integrations))
-"""
 
-hiddenimports.extend(json.loads(exec_statement(statement)))
+hiddenimports += _get_integration_modules()

_pyinstaller_hooks_contrib/stdhooks/hook-sentry_sdk.py

@@ -10,7 +10,18 @@
 # SPDX-License-Identifier: GPL-2.0-or-later
 # ------------------------------------------------------------------
 
-from PyInstaller.utils.hooks import exec_statement
+from PyInstaller import isolated
 
-# This needed because comtypes wx.lib.activex generates some stuff.
-exec_statement("import wx.lib.activex")
+
+# This is necessary because on first import, `wx.lib.activex` generates .tlb file for `comtypes`, unless running in a
+# frozen application (in which case, the .tlb file is expected to exist already). So if we are building in a completely
+# clean python environment (for example, in a CI/CD pipeline), we need to ensure that .tlb file is generated.
+@isolated.decorate
+def _ensure_tlb_file_exists():
+    try:
+        import wx.lib.activex  # noqa: F401
+    except Exception:
+        pass
+
+
+_ensure_tlb_file_exists()