feat: executable version of AB

will7200 · will7200 · commit 2dcc86559be8 · 2024-07-21T00:03:20.000-07:00
diff --git a/activity-browser.spec b/activity-browser.spec
@@ -0,0 +1,94 @@
+# -*- mode: python ; coding: utf-8 -*-
+import argparse
+import os
+import platform
+
+parser = argparse.ArgumentParser()
+parser.add_argument("--debug", action="store_true")
+parser.add_argument("--verbose", action="store_true")
+options = parser.parse_args()
+
+python_options = [
+    ("W ignore", None, "OPTION"),
+]
+if options.verbose:
+    python_options.append(("v", None, "OPTION"))
+
+a = Analysis(
+    ["run-activity-browser.py"],
+    pathex=[],
+    binaries=[],
+    datas=[],
+    hiddenimports=["activity_browser"],
+    hookspath=[],
+    hooksconfig={},
+    runtime_hooks=[],
+    excludes=[],
+    noarchive=False,
+    optimize=0,
+)
+a.datas += Tree("activity_browser/static", prefix="activity_browser/static")
+pyz = PYZ(a.pure)
+
+if options.debug:
+    exe = EXE(
+        pyz,
+        a.scripts,
+        python_options,
+        exclude_binaries=True,
+        name="activity-browser",
+        debug=False,
+        bootloader_ignore_signals=False,
+        strip=False,
+        upx=True,
+        console=False,
+        disable_windowed_traceback=False,
+        argv_emulation=False,
+        target_arch=None,
+        codesign_identity=None,
+        entitlements_file=None,
+    )
+    coll = COLLECT(
+        exe,
+        a.binaries,
+        a.datas,
+        strip=False,
+        upx=True,
+        upx_exclude=[],
+        name="activity-browser",
+    )
+    target = coll
+else:
+    exe = EXE(
+        pyz,
+        a.scripts,
+        python_options,
+        a.binaries,
+        a.datas,
+        name="activity-browser",
+        console=False,
+    )
+    target = exe
+
+if platform.system() == "Darwin":
+    app = BUNDLE(
+        target,
+        name="Activity Browser.app",
+        icon="activity_browser/static/icons/activity-browser.icns",
+        bundle_identifier=None,
+        version=os.environ.get("VERSION", "0.0.0"),
+        info_plist={
+            "NSPrincipalClass": "NSApplication",
+            "NSAppleScriptEnabled": False,
+            "CFBundleDocumentTypes": [
+                {
+                    "CFBundleTypeName": "Icon",
+                    "CFBundleTypeIconFile": "activity_browser/static/icons/activity-browser.icns",
+                    "LSItemContentTypes": [
+                        "com.github.lca_activity_browser.activity_browser"
+                    ],
+                    "LSHandlerRank": "Owner",
+                }
+            ],
+        },
+    )
diff --git a/activity_browser/__init__.py b/activity_browser/__init__.py
@@ -11,6 +11,7 @@
 from .layouts.main import MainWindow
 from .plugin import Plugin
 
+
 def load_settings() -> None:
     if ab_settings.settings:
         bw2data.projects.switch_dir(ab_settings.current_bw_dir)
@@ -19,14 +20,16 @@ def load_settings() -> None:
     log.info(f"Brightway2 current project: {bw2data.projects.current}")
 
 
-def run_activity_browser():
+def run_activity_browser(splash=None):
     log.info(f"Activity Browser version: {version}")
     if log_file_location:
         log.info(f"The log file can be found at {log_file_location}")
 
     application.main_window = MainWindow(application)
     load_settings()
     application.show()
+    if splash:
+        splash.finish(application.main_window)
 
     sys.excepthook = exception_hook
 
diff --git a/activity_browser/application.py b/activity_browser/application.py
@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 import os
 
+from PySide2 import QtWidgets
 from PySide2.QtCore import QCoreApplication, QObject, QSysInfo, Qt
 from PySide2.QtWidgets import QApplication
 
@@ -51,6 +52,8 @@ def deleteLater(self):
     os.environ["QTWEBENGINE_CHROMIUM_FLAGS"] = "--no-sandbox"
     log.info("Info: QtWebEngine sandbox disabled")
 
-QCoreApplication.setAttribute(Qt.AA_ShareOpenGLContexts, True)
-
-application = ABApplication()
+if not QtWidgets.QApplication.instance():
+    QCoreApplication.setAttribute(Qt.AA_ShareOpenGLContexts, True)
+    application = ABApplication()
+else:
+    application: ABApplication = QtWidgets.QApplication.instance()
diff --git a/activity_browser/layouts/panels/right.py b/activity_browser/layouts/panels/right.py
@@ -4,6 +4,7 @@
 
 from activity_browser import log, signals
 from activity_browser.mod import bw2data as bd
+from activity_browser.utils import STATIC_DIR
 
 from ...bwutils.commontasks import get_activity_name
 from ...ui.web import GraphNavigatorWidget, RestrictedWebViewWidget
@@ -22,8 +23,7 @@ class RightPanel(ABTab):
 
     def __init__(self, *args):
         super(RightPanel, self).__init__(*args)
-        package_dir = Path(__file__).resolve().parents[2]
-        html_file = str(package_dir.joinpath("static", "startscreen", "welcome.html"))
+        html_file = str(STATIC_DIR.joinpath("startscreen", "welcome.html"))
         self.tabs = {
             "Welcome": RestrictedWebViewWidget(html_file=html_file),
             "Characterization Factors": CharacterizationFactorsTab(self),
diff --git a/activity_browser/static/icons/activity-browser.icns b/activity_browser/static/icons/activity-browser.icns
diff --git a/activity_browser/static/icons/activity-browser.ico b/activity_browser/static/icons/activity-browser.ico
diff --git a/activity_browser/ui/icons.py b/activity_browser/ui/icons.py
@@ -3,12 +3,12 @@
 
 from PySide2.QtGui import QIcon
 
-PACKAGE_DIR = Path(__file__).resolve().parents[1]
+from activity_browser.utils import STATIC_DIR
 
 
 def create_path(folder: str, filename: str) -> str:
     """Builds a path to the image file."""
-    return str(PACKAGE_DIR.joinpath("static", "icons", folder, filename))
+    return str(STATIC_DIR.joinpath("icons", folder, filename))
 
 
 # CURRENTLY UNUSED ICONS
diff --git a/activity_browser/ui/web/base.py b/activity_browser/ui/web/base.py
@@ -38,7 +38,7 @@ def __init__(self, parent=None, css_file: str = "", *args, **kwargs):
         self.view.loadFinished.connect(self.load_finished_handler)
         self.view.setContextMenuPolicy(Qt.PreventContextMenu)
         self.view.page().setWebChannel(self.channel)
-        self.url = QUrl.fromLocalFile(self.HTML_FILE)
+        self.url = QUrl.fromLocalFile(str(self.HTML_FILE))
         self.css_file = css_file
 
         # Various Qt objects
diff --git a/activity_browser/ui/web/navigator.py b/activity_browser/ui/web/navigator.py
@@ -10,6 +10,7 @@
 
 from activity_browser import log, signals
 from activity_browser.mod.bw2data import Database, get_activity
+from activity_browser.utils import STATIC_DIR
 
 from ...bwutils.commontasks import identify_activity_type
 from .base import BaseGraph, BaseNavigatorWidget
@@ -50,9 +51,7 @@ class GraphNavigatorWidget(BaseNavigatorWidget):
     NAVIGATION MODE:
     Click on activities to jump to specific activities (instead of expanding the graph).
     """
-    HTML_FILE = os.path.join(
-        os.path.abspath(os.path.dirname(__file__)), "../../static/navigator.html"
-    )
+    HTML_FILE = STATIC_DIR.joinpath("navigator.html")
 
     def __init__(self, parent=None, key=None):
         super().__init__(parent, css_file="navigator.css")
diff --git a/activity_browser/ui/web/sankey_navigator.py b/activity_browser/ui/web/sankey_navigator.py
@@ -17,6 +17,7 @@
 from activity_browser import log, signals
 from activity_browser.mod import bw2data as bd
 from activity_browser.mod.bw2data.backends import ActivityDataset
+from activity_browser.utils import STATIC_DIR
 
 from ...bwutils.commontasks import identify_activity_type
 from ...bwutils.superstructure.graph_traversal_with_scenario import (
@@ -45,9 +46,7 @@ class SankeyNavigatorWidget(BaseNavigatorWidget):
     Green flows: Avoided impacts
 
     """
-    HTML_FILE = os.path.join(
-        os.path.abspath(os.path.dirname(__file__)), "../../static/sankey_navigator.html"
-    )
+    HTML_FILE = STATIC_DIR.joinpath("sankey_navigator.html")
 
     def __init__(self, cs_name, parent=None):
         super().__init__(parent, css_file="sankey_navigator.css")
diff --git a/activity_browser/ui/web/webutils.py b/activity_browser/ui/web/webutils.py
@@ -4,7 +4,7 @@
 from PySide2 import QtCore, QtGui, QtWebEngineWidgets, QtWidgets
 
 # type "localhost:3999" in Chrome for DevTools of AB web content
-from activity_browser.utils import get_base_path
+from activity_browser.utils import STATIC_DIR
 
 os.environ["QTWEBENGINE_REMOTE_DEBUGGING"] = "3999"
 
@@ -56,8 +56,8 @@ def __init__(self, parent=None, url=None, html_file=None):
 
 
 def get_static_js_path(file_name: str = "") -> str:
-    return str(get_base_path().joinpath("static", "javascript", file_name))
+    return str(STATIC_DIR.joinpath("javascript", file_name))
 
 
 def get_static_css_path(file_name: str = "") -> str:
-    return str(get_base_path().joinpath("static", "css", file_name))
+    return str(STATIC_DIR.joinpath("css", file_name))
diff --git a/activity_browser/utils.py b/activity_browser/utils.py
@@ -1,18 +1,24 @@
+import importlib
 import os
+import importlib.resources
 from pathlib import Path
 from typing import Iterable, Tuple
 
 import requests
 from bw_processing import safe_filename
 from PySide2 import QtWidgets
 
+import activity_browser
 from activity_browser.mod import bw2data as bd
 
 from .settings import ab_settings
 
+STATIC_DIR = importlib.resources.files(activity_browser) / "static"
 
-def get_base_path() -> Path:
-    return Path(__file__).resolve().parents[0]
+
+def get_package_dir() -> Path:
+    """Return activity_browser package path"""
+    return Path(importlib.util.find_spec("activity_browser").origin).parent
 
 
 def read_file_text(file_dir: str) -> str:
diff --git a/run-activity-browser.py b/run-activity-browser.py
@@ -1,5 +1,90 @@
 # -*- coding: utf-8 -*-
-from activity_browser import run_activity_browser
-import logging
+import importlib
+import os
+import sys
 
-run_activity_browser()
+from PySide2.QtCore import QCoreApplication, QObject, QSysInfo, Qt
+from PySide2.QtGui import QPixmap
+from PySide2.QtWidgets import QApplication
+from PySide2.QtWidgets import QSplashScreen
+
+
+class ABApplication(QApplication):
+    """Matches the ABApplication definied in application.py"""
+
+    _main_window = None
+    _controllers = None
+
+    @property
+    def main_window(self) -> QObject:
+        """Returns the main_window widget of the Activity Browser"""
+        if self._main_window:
+            return self._main_window
+        raise Exception(
+            "main_window not yet initialized, did you try to access it during startup?"
+        )
+
+    @main_window.setter
+    def main_window(self, widget):
+        self._main_window = widget
+
+    def show(self):
+        self.main_window.showMaximized()
+
+    def close(self):
+        for child in self.children():
+            if hasattr(child, "close"):
+                child.close()
+
+    def deleteLater(self):
+        self.main_window.deleteLater()
+
+
+if QSysInfo.productType() == "osx":
+    # https://bugreports.qt.io/browse/QTBUG-87014
+    # https://bugreports.qt.io/browse/QTBUG-85546
+    # https://github.com/mapeditor/tiled/issues/2845
+    # https://doc.qt.io/qt-5/qoperatingsystemversion.html#MacOSBigSur-var
+    supported = {"10.10", "10.11", "10.12", "10.13", "10.14", "10.15"}
+    if QSysInfo.productVersion() not in supported:
+        os.environ["QT_MAC_WANTS_LAYER"] = "1"
+        os.environ["QTWEBENGINE_CHROMIUM_FLAGS"] = "--disable-gpu"
+
+if QSysInfo.productType() in ["arch", "nixos"]:
+    os.environ["QTWEBENGINE_CHROMIUM_FLAGS"] = "--no-sandbox"
+
+QCoreApplication.setAttribute(Qt.AA_ShareOpenGLContexts, True)
+
+
+def show_splash_screen():
+    application = ABApplication(sys.argv)
+    # Create the splash screen
+    splash = QSplashScreen(
+        QPixmap(
+            os.path.join(
+                os.path.dirname(importlib.util.find_spec("activity_browser").origin),
+                "static",
+                "icons",
+                "main",
+                "activitybrowser.png",
+            )
+        ).scaledToHeight(480)
+    )
+    splash.setWindowFlag(Qt.WindowStaysOnTopHint)
+    splash.showMessage(
+        "<h1>Loading, please wait...<h1/>", Qt.AlignBottom | Qt.AlignCenter, Qt.white
+    )
+
+    # Show the splash screen
+    splash.show()
+
+    application.processEvents()
+
+    # from activity_browser import run_activity_browser
+    activity_browser = importlib.import_module("activity_browser")
+    application.processEvents()
+    activity_browser.run_activity_browser(splash)
+
+
+if __name__ == "__main__":
+    show_splash_screen()
