Move building exe to pyinstaller

PyInstaller does not support pkgutil (or at least iter_modules) so the
call in bush.py was replaced by a simple list. There is another call in
localize.py but the function docs there say it's not meant to work when
frozen so I let it be. This is not really an ideal solution for it
should work for testing.

Translation scripts are in the wrong(?) location. I guess some scripts
expect them to be in Mopy/bash/ but not sure how that interacts with
PyInstaller - needs further testing.

Author: Sharlikran

.gitignore

@@ -24,8 +24,10 @@ desktop.ini
 .dropbox
 .DS_Store
 
-# Release archives.
-scripts/dist/*.7z
+# Build-related folders
+scripts/build/standalone/dist/
+scripts/build/standalone/temp/
+scripts/dist/
 
 # Local NSIS
 scripts/build/nsis/

Mopy/bash/bush.py

@@ -36,6 +36,11 @@
 from .env import get_registry_game_path
 from .exception import BoltError
 
+SUPPORTED_GAMES = [
+    "enderal", "fallout3", "fallout4", "falloutnv",
+    "oblivion", "skyrim", "skyrimse"
+]
+
 # Game detection --------------------------------------------------------------
 game = None         # type: game_init.GameInfo
 game_mod = None     # type: game_init
@@ -59,10 +64,8 @@ def _supportedGames():
     """Set games supported by Bash and return their paths from the registry."""
     # rebuilt cache
     reset_bush_globals()
-    import pkgutil
     # Detect the known games
-    for importer, modname, ispkg in pkgutil.iter_modules(game_init.__path__):
-        if not ispkg: continue # game support modules are packages
+    for modname in SUPPORTED_GAMES:
         # Equivalent of "from game import <modname>"
         try:
             module = __import__('game',globals(),locals(),[modname],-1)
@@ -79,7 +82,6 @@ def _supportedGames():
         if registry_path: _registryGames[game_type.fsName] = registry_path
         del module
     # unload some modules, _supportedGames is meant to run once
-    del pkgutil
     _display_fsName.update({v: k for k, v in _fsName_display.iteritems()})
     # Dump out info about all games that we *could* launch, but wrap it
     deprint(u'The following games are supported by this version of Wrye Bash:')

requirements.txt

@@ -8,4 +8,4 @@ scandir~=1.9
 # Compile/Build-time
 pygit2~=0.28
 pyfiglet~=0.8
-https://github.com/wrye-bash/dev-tools/raw/master/wheels/py2exe-0.6.9-cp27-cp27m-win32.whl
+pyinstaller~=3.4

scripts/build.py

@@ -51,6 +51,7 @@
 
 import loot_api
 import pygit2
+import PyInstaller.__main__
 
 import _winreg
 import utils
@@ -131,6 +132,17 @@ def setup_parser(parser):
     parser.set_defaults(version=nightly_version)
 
 
+# PyInstaller thinks it's fine to setup logging on import... -.-
+def setup_pyinstaller_logger(logfile):
+    root_logger = logging.getLogger()
+    stupid_handler = root_logger.handlers[0]
+    stupid_formatter = stupid_handler.formatter
+    root_logger.removeHandler(stupid_handler)
+    file_handler = logging.FileHandler(logfile)
+    file_handler.setFormatter(stupid_formatter)
+    logging.getLogger("PyInstaller").addHandler(file_handler)
+
+
 def get_version_info(version):
     """
     Generates version strings from the passed parameter.
@@ -257,35 +269,24 @@ def pack_manual(version):
 def build_executable(version, file_version):
     """ Builds the executable. """
     LOGGER.info("Building executable...")
-    loot_orig = os.path.join(loot_api.__path__[0], u"loot.dll")
-    loot_target = os.path.join(MOPY_PATH, u"loot.dll")
-    build_folder = os.path.join(MOPY_PATH, u"build")
-    dist_folder = os.path.join(MOPY_PATH, u"dist")
-    setup_orig = os.path.join(WBSA_PATH, u"setup.py")
-    setup_target = os.path.join(MOPY_PATH, u"setup.py")
-    exe_orig = os.path.join(dist_folder, u"Wrye Bash Launcher.exe")
-    exe_target = os.path.join(MOPY_PATH, u"Wrye Bash.exe")
-    cpy(setup_orig, setup_target)
-    # Call the setup script
-    utils.run_subprocess(
-        [sys.executable, setup_target, "py2exe", "--version", file_version],
-        LOGGER,
-        cwd=MOPY_PATH
-    )
-    # Copy the exe's to the Mopy folder
-    cpy(exe_orig, exe_target)
-    # py2exe can't read the loot.dll if it's in the exe
-    # so we have to include it before and delete it after
-    cpy(loot_orig, loot_target)
-    # Clean up py2exe generated files/folders
-    rm(setup_target)
-    rm(build_folder)
-    rm(dist_folder)
+    temp_path = os.path.join(WBSA_PATH, u"temp")
+    dist_path = os.path.join(WBSA_PATH, u"dist")
+    spec_path = os.path.join(WBSA_PATH, u"pyinstaller.spec")
+    orig_exe = os.path.join(dist_path, u"Wrye Bash.exe")
+    dest_exe = os.path.join(MOPY_PATH, u"Wrye Bash.exe")
+    PyInstaller.__main__.run([
+        "--clean",
+        "--noconfirm",
+        "--distpath={}".format(dist_path),
+        "--workpath={}".format(temp_path),
+        spec_path,
+    ])
+    # Copy the exe to the Mopy folder
+    cpy(orig_exe, dest_exe)
     try:
         yield
     finally:
-        rm(exe_target)
-        rm(loot_target)
+        rm(dest_exe)
 
 
 def pack_standalone(version):
@@ -426,6 +427,7 @@ def check_timestamp(build_version):
 
 
 def main(args):
+    setup_pyinstaller_logger(LOGFILE)
     utils.setup_log(LOGGER, verbosity=args.verbosity, logfile=LOGFILE)
     # check nightly timestamp is different than previous
     if not check_timestamp(args.version):

scripts/build/installer/macros.nsh

@@ -45,7 +45,6 @@
             ; Install the standalone only files
             SetOutPath "${GameDir}\Mopy"
             File "${WB_CLEAN_MOPY}\Wrye Bash.exe"
-            File "${WB_CLEAN_MOPY}\loot.dll"
             ; Write the installation path into the registry
             WriteRegStr HKLM "SOFTWARE\Wrye Bash" "${GameName} Standalone Version" "True"
         ${ElseIf} ${RegValueExe} == $Empty

scripts/build/standalone/pyinstaller.spec

@@ -0,0 +1,62 @@
+# -*- mode: python -*-
+
+import fnmatch
+import os
+import sys
+
+def real_sys_prefix():
+    if hasattr(sys, "real_prefix"):  # running in virtualenv
+        return sys.real_prefix
+    elif hasattr(sys, "base_prefix"):  # running in venv
+        return sys.base_prefix
+    else:
+        return sys.prefix
+
+TOOL_PATH = os.path.join(real_sys_prefix(), "Tools", "i18n")
+WBSA_PATH = SPECPATH  # pyinstaller-defined global
+ROOT_PATH = os.path.join(WBSA_PATH, "..", "..", "..")
+MOPY_PATH = os.path.join(ROOT_PATH, "Mopy")
+GAME_PATH = os.path.join(MOPY_PATH, "bash", "game")
+
+block_cipher = None
+entry_point = os.path.join(MOPY_PATH, "Wrye Bash Launcher.pyw")
+icon_path = os.path.join(WBSA_PATH, "bash.ico")
+manifest_path = os.path.join(WBSA_PATH, "manifest.xml")
+hiddenimports = ["pygettext", "msgfmt"]
+
+for root, _, filenames in os.walk(GAME_PATH):
+    for filename in fnmatch.filter(filenames, '*.py'):
+        path = os.path.join(root, filename)
+        path = path[:-3]  # remove '.py'
+        import_path = os.path.relpath(path, start=MOPY_PATH)
+        hiddenimports.append(import_path.replace(os.sep, "."))
+
+a = Analysis([entry_point],
+             pathex=[TOOL_PATH, ROOT_PATH],
+             binaries=[],
+             datas=[],
+             hiddenimports=hiddenimports,
+             hookspath=[],
+             runtime_hooks=[],
+             excludes=[],
+             win_no_prefer_redirects=False,
+             win_private_assemblies=False,
+             cipher=block_cipher,
+             noarchive=False)
+pyz = PYZ(a.pure, a.zipped_data,
+          cipher=block_cipher)
+exe = EXE(pyz,
+          a.scripts,
+          a.binaries,
+          a.zipfiles,
+          a.datas,
+          [],
+          name='Wrye Bash',
+          debug=False,
+          bootloader_ignore_signals=False,
+          strip=False,
+          upx=True,
+          runtime_tmpdir=None,
+          console=False,
+          icon=icon_path,
+          manifest=manifest_path)