Compatibility with pyinstaller

eos/db/migrations/__init__.py

@@ -8,43 +8,25 @@ many upgrade files as there are database versions (version 5 would include
 upgrade files 1-5)
 """
 
-import pkgutil
 import re
 
+from eos.utils.pyinst_support import iterNamespace
+
 updates = {}
 appVersion = 0
 
 prefix = __name__ + "."
 
-# load modules to work based with and without pyinstaller
-# from: https://github.com/webcomics/dosage/blob/master/dosagelib/loader.py
-# see: https://github.com/pyinstaller/pyinstaller/issues/1905
-
-# load modules using iter_modules()
-# (should find all filters in normal build, but not pyinstaller)
-module_names = [m[1] for m in pkgutil.iter_modules(__path__, prefix)]
-
-# special handling for PyInstaller
-importers = map(pkgutil.get_importer, __path__)
-toc = set()
-for i in importers:
-    if hasattr(i, 'toc'):
-        toc |= i.toc
-
-for elm in toc:
-    if elm.startswith(prefix):
-        module_names.append(elm)
-
-for modname in module_names:
+for modName in iterNamespace(__name__, __path__):
     # loop through python files, extracting update number and function, and
     # adding it to a list
-    modname_tail = modname.rsplit('.', 1)[-1]
-    module = __import__(modname, fromlist=True)
+    modname_tail = modName.rsplit('.', 1)[-1]
     m = re.match("^upgrade(?P<index>\d+)$", modname_tail)
     if not m:
         continue
     index = int(m.group("index"))
     appVersion = max(appVersion, index)
+    module = __import__(modName, fromlist=True)
     upgrade = getattr(module, "upgrade", False)
     if upgrade:
         updates[index] = upgrade

eos/utils/pyinst_support.py

@@ -0,0 +1,39 @@
+"""
+Slightly modified version of function taken from here:
+https://github.com/pyinstaller/pyinstaller/issues/1905#issuecomment-525221546
+"""
+
+
+import pkgutil
+
+
+def iterNamespace(name, path):
+    """Pyinstaller-compatible namespace iteration.
+
+    Yields the name of all modules found at a given Fully-qualified path.
+
+    To have it running with pyinstaller, it requires to ensure a hook inject the
+    "hidden" modules from your plugins folder inside the executable:
+
+    - if your plugins are under the ``myappname/pluginfolder`` module
+    - create a file ``specs/hook-<myappname.pluginfolder>.py``
+    - content of this file should be:
+
+        .. code-block:: python
+
+            from PyInstaller.utils.hooks import collect_submodules
+            hiddenimports = collect_submodules('<myappname.pluginfolder>')
+    """
+    prefix = name + "."
+    for p in pkgutil.iter_modules(path, prefix):
+        yield p[1]
+
+    # special handling when the package is bundled with PyInstaller 3.5
+    # See https://github.com/pyinstaller/pyinstaller/issues/1905#issuecomment-445787510
+    toc = set()
+    for importer in pkgutil.iter_importers(name.partition(".")[0]):
+        if hasattr(importer, 'toc'):
+            toc |= importer.toc
+    for name in toc:
+        if name.startswith(prefix):
+            yield name