Add hook for patoolib

news/748.new.rst

@@ -0,0 +1,2 @@
+Add hook for ``patoolib`` to collect dynamically-imported modules from
+the ``patoolib.programs`` sub-package.

requirements-test-libraries.txt

@@ -178,6 +178,7 @@ opentelemetry-sdk==1.24.0
 xarray==2024.5.0; python_version >= '3.9'
 tables==3.9.2; python_version >= '3.9'
 schwifty==2024.5.3
+patool==2.2.0; python_version >= '3.10'
 
 # ------------------- Platform (OS) specifics
 

src/_pyinstaller_hooks_contrib/hooks/stdhooks/hook-patoolib.py

@@ -0,0 +1,16 @@
+#-----------------------------------------------------------------------------
+# Copyright (c) 2017-2024, PyInstaller Development Team.
+#
+# Distributed under the terms of the GNU General Public License with exception
+# for distributing bootloader.
+#
+# The full license is in the file COPYING.txt, distributed with this software.
+#-----------------------------------------------------------------------------
+
+
+"""
+patoolib uses importlib and pyinstaller doesn't find it and add it to the list of needed modules
+"""
+
+from PyInstaller.utils.hooks import collect_submodules
+hiddenimports = collect_submodules('patoolib.programs')

src/_pyinstaller_hooks_contrib/tests/test_libraries.py

@@ -2097,3 +2097,24 @@ async def main():
 
         asyncio.run(main())
     """)
+
+
+@importorskip('patoolib')
+def test_patoolib(pyi_builder):
+    pyi_builder.test_source("""
+        import patoolib
+
+        archive = 'archive.zip'
+
+        # The call to `get_archive_cmdlist_func` triggers import of module from `patoolib.programs` via
+        # `importlib.import_module`; the set up below is based on code from `patoolib._extract_archive`.
+        archive_format, compression = patoolib.get_archive_format(archive)
+        print(f"Archive format: {archive_format}")
+        print(f"Compression: compression")
+
+        program = patoolib.find_archive_program(archive_format, 'extract')
+        print(f"Program: {program}")
+
+        cmdlist = patoolib.get_archive_cmdlist_func(program, 'extract', archive_format)
+        print(f"Cmdlist: {cmdlist}")
+    """)