BERATools 0.2.3__py3-none-any.whl → 0.2.4__py3-none-any.whl

beratools/gui/bt_gui_main.py

@@ -12,44 +12,38 @@ Description:
 
     The purpose of this script is to provide main GUI functions.
 """
+
 import json
 import os
+import shlex
 import sys
 import webbrowser
 from pathlib import Path
-from re import compile
-
-from PyQt5 import QtCore, QtGui, QtWidgets
 
 import beratools.core.constants as bt_const
-import beratools.tools.common as bt_common
 from beratools.gui import bt_data
+from beratools.utility import env_checks
 from beratools.gui.tool_widgets import ToolWidgets
 
-# A regular expression, to extract the % complete.
-progress_re = compile("Total complete: (\d+)%")
-bt = bt_data.BTData()
-
-
-def simple_percent_parser(output):
-    """
-    Match lines using the progress_re regex.
+from PyQt5 import QtCore, QtGui, QtWidgets
 
-    Return a single integer for the % progress.
-    """
-    m = progress_re.search(output)
-    if m:
-        pc_complete = m.group(1)
-        return int(pc_complete)
+bt = bt_data.BTData()
 
+def extract_string_from_printout(str_print, str_extract):
+    str_array = shlex.split(str_print)  # keep string in double quotes
+    str_array_enum = enumerate(str_array)
+    index = 0
+    for item in str_array_enum:
+        if str_extract in item[1]:
+            index = item[0]
+            break
+    str_out = str_array[index]
+    return str_out.strip()
 
 class _SearchProxyModel(QtCore.QSortFilterProxyModel):
-
     def setFilterRegExp(self, pattern):
         if isinstance(pattern, str):
-            pattern = QtCore.QRegExp(
-                pattern, QtCore.Qt.CaseInsensitive, QtCore.QRegExp.FixedString
-            )
+            pattern = QtCore.QRegExp(pattern, QtCore.Qt.CaseInsensitive, QtCore.QRegExp.FixedString)
         super(_SearchProxyModel, self).setFilterRegExp(pattern)
 
     def _accept_index(self, idx):
@@ -77,7 +71,7 @@ class BTTreeView(QtWidgets.QWidget):
 
         # controls
         self.tool_search = QtWidgets.QLineEdit()
-        self.tool_search.setPlaceholderText('Search...')
+        self.tool_search.setPlaceholderText("Search...")
 
         self.tags_model = _SearchProxyModel()
         self.tree_model = QtGui.QStandardItemModel()
@@ -110,7 +104,7 @@ class BTTreeView(QtWidgets.QWidget):
         self.tree_view.setFirstColumnSpanned(0, self.tree_view.rootIndex(), True)
         self.tree_view.setUniformRowHeights(True)
 
-        self.tree_model.setHorizontalHeaderLabels(['Tools'])
+        self.tree_model.setHorizontalHeaderLabels(["Tools"])
         self.tree_sel_model = self.tree_view.selectionModel()
         self.tree_sel_model.selectionChanged.connect(self.tree_view_selection_changed)
 
@@ -146,9 +140,7 @@ class BTTreeView(QtWidgets.QWidget):
                 QtGui.QIcon(os.path.join(bt_const.ASSETS_PATH, "close.gif")), toolbox
             )
             for j, tool in enumerate(sorted_tools[i]):
-                child = QtGui.QStandardItem(
-                    QtGui.QIcon(os.path.join(bt_const.ASSETS_PATH, "tool.gif")), tool
-                )
+                child = QtGui.QStandardItem(QtGui.QIcon(os.path.join(bt_const.ASSETS_PATH, "tool.gif")), tool)
                 if i == 0 and j == 0:
                     first_child = child
 
@@ -178,21 +170,19 @@ class BTTreeView(QtWidgets.QWidget):
             return
 
         if item.hasChildren():
-            item.setIcon(QtGui.QIcon(os.path.join(bt_const.ASSETS_PATH, 'open.gif')))
+            item.setIcon(QtGui.QIcon(os.path.join(bt_const.ASSETS_PATH, "open.gif")))
 
     def tree_item_collapsed(self, index):
         source_index = self.tags_model.mapToSource(index)
         item = self.tree_model.itemFromIndex(source_index)
         if not item:
             return
-        
+
         if item.hasChildren():
-            item.setIcon(QtGui.QIcon(os.path.join(bt_const.ASSETS_PATH, 'close.gif')))
+            item.setIcon(QtGui.QIcon(os.path.join(bt_const.ASSETS_PATH, "close.gif")))
 
     def get_tool_index(self, tool_name):
-        item = self.tree_model.findItems(
-            tool_name, QtCore.Qt.MatchExactly | QtCore.Qt.MatchRecursive
-        )
+        item = self.tree_model.findItems(tool_name, QtCore.Qt.MatchExactly | QtCore.Qt.MatchRecursive)
         if len(item) > 0:
             item = item[0]
 
@@ -201,13 +191,9 @@ class BTTreeView(QtWidgets.QWidget):
 
     def select_tool_by_index(self, index):
         proxy_index = self.tags_model.mapFromSource(index)
-        self.tree_sel_model.select(
-            proxy_index, QtCore.QItemSelectionModel.ClearAndSelect
-        )
+        self.tree_sel_model.select(proxy_index, QtCore.QItemSelectionModel.ClearAndSelect)
         self.tree_view.expand(proxy_index.parent())
-        self.tree_sel_model.setCurrentIndex(
-            proxy_index, QtCore.QItemSelectionModel.Current
-        )
+        self.tree_sel_model.setCurrentIndex(proxy_index, QtCore.QItemSelectionModel.Current)
 
     def select_tool_by_name(self, name):
         index = self.get_tool_index(name)
@@ -276,15 +262,15 @@ class BTSlider(QtWidgets.QWidget):
         self.slider.sliderMoved.connect(self.slider_moved)
 
     def slider_moved(self, value):
-        bt.set_max_procs(value)
-        QtWidgets.QToolTip.showText(QtGui.QCursor.pos(), f'{value}')
+        bt.set_selected_cpu_cores(value)
+        QtWidgets.QToolTip.showText(QtGui.QCursor.pos(), f"{value}")
         self.label.setText(self.generate_label_text())
 
     def generate_label_text(self, value=None):
         if not value:
             value = self.slider.value()
 
-        return f'Use CPU Cores: {value:3d}'
+        return f"Use CPU Cores: {value:3d}"
 
 
 class BTListView(QtWidgets.QWidget):
@@ -303,8 +289,8 @@ class BTListView(QtWidgets.QWidget):
         btn_clear = QtWidgets.QPushButton()
         btn_delete.setIcon(delete_icon)
         btn_clear.setIcon(clear_icon)
-        btn_delete.setToolTip('Delete selected tool history')
-        btn_clear.setToolTip('clear all tool history')
+        btn_delete.setToolTip("Delete selected tool history")
+        btn_clear.setToolTip("clear all tool history")
         btn_delete.setFixedWidth(40)
         btn_clear.setFixedWidth(40)
 
@@ -363,11 +349,11 @@ class MainWindow(QtWidgets.QMainWindow):
         super().__init__()
 
         self.script_dir = os.path.dirname(os.path.realpath(__file__))
-        self.title = 'BERA Tools'
+        self.title = "BERA Tools"
         self.setWindowTitle(self.title)
         self.working_dir = bt.work_dir
         self.tool_api = None
-        self.tool_name = 'Centerline'
+        self.tool_name = "Centerline"
         self.recent_tool = bt.recent_tool
         if self.recent_tool:
             self.tool_name = self.recent_tool
@@ -396,7 +382,7 @@ class MainWindow(QtWidgets.QMainWindow):
 
         # group box for tree view
         tree_box = QtWidgets.QGroupBox()
-        tree_box.setTitle('Tools available')
+        tree_box.setTitle("Tools available")
         tree_layout = QtWidgets.QVBoxLayout()
         tree_layout.addWidget(self.tree_view)
         tree_box.setLayout(tree_layout)
@@ -410,7 +396,7 @@ class MainWindow(QtWidgets.QMainWindow):
         tool_history_box = QtWidgets.QGroupBox()
         tool_history_layout = QtWidgets.QVBoxLayout()
         tool_history_layout.addWidget(self.tool_history)
-        tool_history_box.setTitle('Tool history')
+        tool_history_box.setTitle("Tool history")
         tool_history_box.setLayout(tool_history_layout)
 
         # left layout
@@ -422,35 +408,35 @@ class MainWindow(QtWidgets.QMainWindow):
         self.left_layout.addWidget(tool_history_box)
 
         # top buttons
-        label = QtWidgets.QLabel(f'{self.tool_name}')
-        label.setFont(QtGui.QFont('Consolas', 14))
-        self.btn_advanced = QtWidgets.QPushButton('Show Advanced Options')
+        label = QtWidgets.QLabel(f"{self.tool_name}")
+        label.setFont(QtGui.QFont("Consolas", 14))
+        self.btn_advanced = QtWidgets.QPushButton("Show Advanced Options")
         self.btn_advanced.setFixedWidth(180)
-        btn_help = QtWidgets.QPushButton('help')
-        btn_code = QtWidgets.QPushButton('Code')
-        btn_help.setFixedWidth(250)
-        btn_code.setFixedWidth(100)
+        btn_help = QtWidgets.QPushButton("help")
+        btn_help.setFixedWidth(100)
 
         self.btn_layout_top = QtWidgets.QHBoxLayout()
         self.btn_layout_top.setAlignment(QtCore.Qt.AlignRight)
         self.btn_layout_top.addWidget(label)
         self.btn_layout_top.addStretch(1)
         self.btn_layout_top.addWidget(self.btn_advanced)
-        self.btn_layout_top.addWidget(btn_code)
+        self.btn_layout_top.addWidget(btn_help)
 
         # ToolWidgets
         tool_args = bt.get_bera_tool_args(self.tool_name)
         self.tool_widget = ToolWidgets(self.recent_tool, tool_args, bt.show_advanced)
 
         # bottom buttons
-        slider = BTSlider(bt.max_procs, bt.max_cpu_cores)
-        btn_default_args = QtWidgets.QPushButton('Load Default Arguments')
-        self.btn_run = QtWidgets.QPushButton('Run')
-        btn_cancel = QtWidgets.QPushButton('Cancel')
+        slider = BTSlider(bt.selected_cpu_cores, bt.max_cpu_cores)
+        btn_default_args = QtWidgets.QPushButton("Load Default Arguments")
+        self.btn_run = QtWidgets.QPushButton("Run")
+        btn_cancel = QtWidgets.QPushButton("Cancel")
+        btn_exit = QtWidgets.QPushButton("Exit")
         btn_default_args.setFixedWidth(150)
         slider.setFixedWidth(250)
         self.btn_run.setFixedWidth(120)
         btn_cancel.setFixedWidth(120)
+        btn_exit.setFixedWidth(120)
 
         btn_layout_bottom = QtWidgets.QHBoxLayout()
         btn_layout_bottom.setAlignment(QtCore.Qt.AlignRight)
@@ -459,17 +445,18 @@ class MainWindow(QtWidgets.QMainWindow):
         btn_layout_bottom.addWidget(slider)
         btn_layout_bottom.addWidget(self.btn_run)
         btn_layout_bottom.addWidget(btn_cancel)
+        btn_layout_bottom.addWidget(btn_exit)
 
         self.top_right_layout = QtWidgets.QVBoxLayout()
         self.top_right_layout.addLayout(self.btn_layout_top)
         self.top_right_layout.addWidget(self.tool_widget)
         self.top_right_layout.addLayout(btn_layout_bottom)
-        tool_widget_grp = QtWidgets.QGroupBox('Tool')
+        tool_widget_grp = QtWidgets.QGroupBox("Tool")
         tool_widget_grp.setLayout(self.top_right_layout)
 
         # Text widget
         self.text_edit = QtWidgets.QPlainTextEdit()
-        self.text_edit.setFont(QtGui.QFont('Consolas', 9))
+        self.text_edit.setFont(QtGui.QFont("Consolas", 9))
         self.text_edit.setReadOnly(True)
         self.print_about()
 
@@ -494,15 +481,33 @@ class MainWindow(QtWidgets.QMainWindow):
         # signals and slots
         self.btn_advanced.clicked.connect(self.show_advanced)
         btn_help.clicked.connect(self.show_help)
-        btn_code.clicked.connect(self.view_code)
         btn_default_args.clicked.connect(self.load_default_args)
         self.btn_run.clicked.connect(self.start_process)
         btn_cancel.clicked.connect(self.stop_process)
+        btn_exit.clicked.connect(self.close)
 
         widget = QtWidgets.QWidget(self)
         widget.setLayout(page_layout)
         self.setCentralWidget(widget)
 
+    def closeEvent(self, event):
+        self.cancel_op = True
+        if self.process is None:
+            window_msg="Are you sure you want to quit?"
+        else:
+            window_msg="Work in progress. Are you sure you want to quit?"
+
+        reply= QtWidgets.QMessageBox.question(self,'Confirmation:',window_msg,
+                                     QtWidgets.QMessageBox.StandardButton.Yes | QtWidgets.QMessageBox.StandardButton.No,
+                                     QtWidgets.QMessageBox.StandardButton.No)
+
+        if reply == QtWidgets.QMessageBox.StandardButton.Yes:
+            if self.process is not None:
+                self.process.kill()
+            event.accept()
+        else:
+            event.ignore()
+
     def set_tool(self, tool=None):
         if tool:
             self.tool_name = tool
@@ -539,19 +544,33 @@ class MainWindow(QtWidgets.QMainWindow):
 
     def show_help(self):
         # open the user manual section for the current tool
-        webbrowser.open_new_tab(self.get_current_tool_parameters()['tech_link'])
+        tech_link = self.get_current_tool_parameters()["tech_link"]
+        if isinstance(tech_link, list):
+            if tech_link:
+                tech_link = tech_link[0]
+            else:
+                tech_link = ""
+        webbrowser.open_new_tab(str(tech_link))
 
     def print_about(self):
         self.text_edit.clear()
         self.print_to_output(bt.about())
+        self.show_startup_warnings()
+
+    def show_startup_warnings(self):
+        warning_message = env_checks.get_gdal_proj_env_warning()
+        if warning_message:
+            self.print_line_to_output("")
+            self.print_line_to_output("[Warning]")
+            self.print_line_to_output(warning_message)
 
     def print_license(self):
         self.text_edit.clear()
         self.print_to_output(bt.license())
 
     def update_procs(self, value):
-        max_procs = int(value)
-        bt.set_max_procs(max_procs)
+        selected_cpu_cores = int(value)
+        bt.set_selected_cpu_cores(selected_cpu_cores)
 
     def print_to_output(self, text):
         self.text_edit.moveCursor(QtGui.QTextCursor.End)
@@ -560,7 +579,7 @@ class MainWindow(QtWidgets.QMainWindow):
 
     def print_line_to_output(self, text, tag=None):
         self.text_edit.moveCursor(QtGui.QTextCursor.End)
-        self.text_edit.insertPlainText(text + '\n')
+        self.text_edit.insertPlainText(text + "\n")
         self.text_edit.moveCursor(QtGui.QTextCursor.End)
 
     def show_advanced(self):
@@ -573,35 +592,33 @@ class MainWindow(QtWidgets.QMainWindow):
 
         self.set_tool()
 
-    def view_code(self):
-        webbrowser.open_new_tab(self.get_current_tool_parameters()['tech_link'])
 
     def custom_callback(self, value):
         """Define custom callback that deals with tool output."""
         value = str(value)
         value.strip()
-        if value != '':
+        if value != "":
             # remove esc string which origin is unknown
-            rm_str = '\x1b[0m'
+            rm_str = "\x1b[0m"
             if rm_str in value:
-                value = value.replace(rm_str, '')
+                value = value.replace(rm_str, "")
 
         if "%" in value:
             try:
-                str_progress = bt_common.extract_string_from_printout(value, '%')
+                str_progress = extract_string_from_printout(value, "%")
 
                 # remove progress string
-                value = value.replace(str_progress, '').strip()  
+                value = value.replace(str_progress, "").strip()
                 progress = float(str_progress.replace("%", "").strip())
                 self.progress_bar.setValue(int(progress))
             except ValueError as e:
                 print("custom_callback: Problem parsing data into number: ", e)
             except Exception as e:
                 print(e)
-        elif 'PROGRESS_LABEL' in value:
-            str_label = bt_common.extract_string_from_printout(value, 'PROGRESS_LABEL')
-            value = value.replace(str_label, '').strip()  # remove progress string
-            value = value.replace('"', '')
+        elif "PROGRESS_LABEL" in value:
+            str_label = extract_string_from_printout(value, "PROGRESS_LABEL")
+            value = value.replace(str_label, "").strip()  # remove progress string
+            value = value.replace('"', "")
             str_label = str_label.replace("PROGRESS_LABEL", "").strip()
             self.progress_label.setText(str_label)
 
@@ -617,12 +634,12 @@ class MainWindow(QtWidgets.QMainWindow):
     def start_process(self):
         args = self.tool_widget.get_widgets_arguments()
         if not args:
-            print('Please check the parameters.')
+            print("Please check the parameters.")
             return
 
         self.print_line_to_output("")
-        self.print_line_to_output(f'Starting tool {self.tool_name} ... \n')
-        self.print_line_to_output('-----------------------------')
+        self.print_line_to_output(f"Starting tool {self.tool_name} ... \n")
+        self.print_line_to_output("-----------------------------")
         self.print_line_to_output("Tool arguments:")
         self.print_line_to_output(json.dumps(args, indent=4))
         self.print_line_to_output("")
@@ -635,7 +652,7 @@ class MainWindow(QtWidgets.QMainWindow):
             if type(args[key]) is not str:
                 args[key] = str(args[key])
 
-        tool_type, tool_args = bt.run_tool(self.tool_api, args, self.custom_callback)
+        tool_type, tool_args = bt.prepare_tool_run(self.tool_api, args, self.custom_callback)
 
         if self.process is None:  # No process running.
             self.print_line_to_output(f"Tool {self.tool_name} started")
@@ -646,7 +663,7 @@ class MainWindow(QtWidgets.QMainWindow):
             self.process.stateChanged.connect(self.handle_state)
 
             # Clean up once complete.
-            self.process.finished.connect(self.process_finished)  
+            self.process.finished.connect(self.process_finished)
             self.process.start(tool_type, tool_args)
 
         while self.process is not None:
@@ -667,10 +684,6 @@ class MainWindow(QtWidgets.QMainWindow):
         data = self.process.readAllStandardError()
         stderr = bytes(data).decode("utf8")
 
-        # Extract progress if it is in the data.
-        progress = simple_percent_parser(stderr)
-        if progress:
-            self.progress_bar.setValue(progress)
         self.message(stderr)
 
     def handle_stdout(self):
@@ -688,11 +701,11 @@ class MainWindow(QtWidgets.QMainWindow):
             QtCore.QProcess.Running: "Running",
         }
         state_name = states[state]
-        if state_name == 'Not running':
+        if state_name == "Not running":
             self.btn_run.setEnabled(True)
             if self.cancel_op:
-                self.message('Tool operation canceled')
-        elif state_name == 'Starting':
+                self.message("Tool operation canceled")
+        elif state_name == "Starting":
             self.btn_run.setEnabled(False)
 
     def process_finished(self):
@@ -704,7 +717,32 @@ class MainWindow(QtWidgets.QMainWindow):
 
 def runner():
     app = QtWidgets.QApplication(sys.argv)
+
+    # Use absolute path for icons (works with embedded Python on Windows)
+    assets_path = Path(__file__).parent / "assets"
+    app.setWindowIcon(QtGui.QIcon(str(assets_path / "BERALogo.ico")))
     window = MainWindow()
     window.setMinimumSize(1024, 768)
     window.show()
-    app.exec()
+
+    # Cross-platform tray icon (Windows: .ico, macOS: .png)
+    import platform
+    if platform.system() == "Darwin":
+        tray_icon_path = assets_path / "BERALogo.png"
+    else:
+        tray_icon_path = assets_path / "BERALogo.ico"
+    tray_icon = QtWidgets.QSystemTrayIcon(QtGui.QIcon(str(tray_icon_path)), app)
+    tray_icon.setToolTip("BERA Tools")
+    tray_icon.show()
+
+    def signal_ready():
+        ready_flag = os.getenv("BERA_SPLASH_READY")
+        if ready_flag:
+            try:
+                from pathlib import Path
+                Path(ready_flag).touch()
+            except Exception:
+                pass
+
+    QtCore.QTimer.singleShot(100, signal_ready)
+    app.exec_()

beratools/gui/main.py

@@ -12,15 +12,12 @@ Description:
 
     Main entry point of BERA Tools.
 """
-import sys
-from pathlib import Path
-
-if __name__ == "__main__":
-    current_file = Path(__file__).resolve()
-    btool_dir = current_file.parents[2]
-    sys.path.insert(0, btool_dir.as_posix())
 
 from beratools.gui.bt_gui_main import runner
 
+
+def gui_main():
+    runner()
+
 if __name__ == "__main__":
     runner()