nova-trame 0.22.0__py3-none-any.whl → 0.22.1__py3-none-any.whl

nova/trame/view/theme/exit_button.py

@@ -0,0 +1,73 @@
+"""Components used to control the lifecycle of a Themed Application."""
+
+import logging
+from typing import Any
+
+from trame.app import get_server
+from trame.widgets import vuetify3 as vuetify
+
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.INFO)
+
+
+class ExitButton:
+    """Exit button for Trame Applications."""
+
+    def __init__(self, exit_callback: Any = None, job_status_callback: Any = None) -> None:
+        self.server = get_server(None, client_type="vue3")
+        self.server.state.nova_kill_jobs_on_exit = False
+        self.server.state.nova_show_exit_dialog = False
+        self.server.state.nova_show_stop_jobs_on_exit_checkbox = False
+        self.server.state.nova_running_jobs = []
+        self.server.state.nova_show_exit_progress = False
+        self.exit_application_callback = exit_callback
+        self.job_status_callback = job_status_callback
+        self.create_ui()
+
+    def create_ui(self) -> None:
+        with vuetify.VBtn(
+            "Exit",
+            prepend_icon="mdi-close-box",
+            classes="mr-4 bg-error",
+            id="shutdown_app_theme_button",
+            color="white",
+            click=self.open_exit_dialog,
+        ):
+            with vuetify.VDialog(v_model="nova_show_exit_dialog", persistent="true"):
+                with vuetify.VCard(classes="pa-4 ma-auto"):
+                    vuetify.VCardTitle("Exit Application")
+                    with vuetify.VCardText(
+                        "Are you sure you want to exit this application?",
+                        variant="outlined",
+                    ):
+                        vuetify.VCheckbox(
+                            v_model="nova_kill_jobs_on_exit",
+                            label="Stop All Jobs On Exit.",
+                            v_if="nova_running_jobs.length > 0",
+                        )
+                        with vuetify.VList():
+                            vuetify.VListSubheader("Running Jobs:", v_if="nova_running_jobs.length > 0")
+                            vuetify.VListItem("{{ item }}", v_for="(item, index) in nova_running_jobs")
+                    with vuetify.VCardActions(v_if="!nova_show_exit_progress"):
+                        vuetify.VBtn(
+                            "Exit App",
+                            click=self.exit_application_callback,
+                            color="error",
+                        )
+                        vuetify.VBtn(
+                            "Stay In App",
+                            click=self.close_exit_dialog,
+                        )
+                    with vuetify.VCardActions(v_else=True):
+                        vuetify.VCardText(
+                            "Exiting Application...",
+                            variant="outlined",
+                        )
+                        vuetify.VProgressCircular(indeterminate=True)
+
+    async def open_exit_dialog(self) -> None:
+        self.server.state.nova_show_exit_dialog = True
+        await self.job_status_callback()
+
+    async def close_exit_dialog(self) -> None:
+        self.server.state.nova_show_exit_dialog = False

nova/trame/view/theme/theme.py

@@ -1,12 +1,15 @@
 """Implementation of ThemedApp."""
 
+import asyncio
 import json
 import logging
+import sys
 from asyncio import create_task
 from functools import partial
 from pathlib import Path
 from typing import Optional
 
+import blinker
 import sass
 from mergedeep import Strategy, merge
 from trame.app import get_server
@@ -18,7 +21,9 @@ from trame_client.widgets import html
 from trame_server.core import Server
 from trame_server.state import State
 
+from nova.common.signals import Signal
 from nova.mvvm.pydantic_utils import validate_pydantic_parameter
+from nova.trame.view.theme.exit_button import ExitButton
 from nova.trame.view.utilities.local_storage import LocalStorageManager
 
 THEME_PATH = Path(__file__).parent
@@ -138,6 +143,29 @@ class ThemedApp:
     async def init_theme(self) -> None:
         create_task(self._init_theme())
 
+    async def get_jobs_callback(self) -> None:
+        get_tools_signal = blinker.signal(Signal.GET_ALL_TOOLS)
+        response = get_tools_signal.send()
+        if response and len(response[0]) > 1:  # Make sure that the callback had a return value
+            try:
+                self.server.state.nova_running_jobs = [tool.id for tool in response[0][1]]
+                if len(self.server.state.nova_running_jobs) > 0:
+                    self.server.state.nova_show_stop_jobs_on_exit_checkbox = True
+                    self.server.state.nova_kill_jobs_on_exit = True
+                else:
+                    self.server.state.nova_show_stop_jobs_on_exit_checkbox = False
+            except Exception as e:
+                logger.warning(f"Issue getting running jobs: {e}")
+
+    async def exit_callback(self) -> None:
+        logger.info(f"Closing App. Killing jobs: {self.server.state.nova_kill_jobs_on_exit}")
+        if self.server.state.nova_kill_jobs_on_exit:
+            self.server.state.nova_show_exit_progress = True
+            await asyncio.sleep(2)
+            stop_signal = blinker.signal(Signal.EXIT_SIGNAL)
+            stop_signal.send()
+        sys.exit(0)
+
     def set_theme(self, theme: Optional[str], force: bool = True) -> None:
         """Sets the theme of the application.
 
@@ -227,6 +255,7 @@ class ThemedApp:
                                                 "Selected",
                                                 v_if=f"nova__theme === '{theme['value']}'",
                                             )
+                            ExitButton(self.exit_callback, self.get_jobs_callback)
 
                     with vuetify.VMain(classes="align-stretch d-flex flex-column h-screen"):
                         # [slot override example]

{nova_trame-0.22.0.dist-info → nova_trame-0.22.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: nova-trame
-Version: 0.22.0
+Version: 0.22.1
 Summary: A Python Package for injecting curated themes and custom components into Trame applications
 License: MIT
 Keywords: NDIP,Python,Trame,Vuetify
@@ -18,7 +18,7 @@ Requires-Dist: blinker (>=1.9.0,<2.0.0)
 Requires-Dist: libsass
 Requires-Dist: mergedeep
 Requires-Dist: natsort (>=8.4.0,<9.0.0)
-Requires-Dist: nova-common (>=0.2.0)
+Requires-Dist: nova-common (>=0.2.2)
 Requires-Dist: nova-mvvm
 Requires-Dist: pydantic
 Requires-Dist: tomli
@@ -43,7 +43,7 @@ You can install this package directly with
 pip install nova-trame
 ```
 
-A user guide, examples, and a full API for this package can be found at https://nova-application-development.readthedocs.io/en/stable/.
+A user guide, examples, and a full API for this package can be found at [https://nova-application-development.readthedocs.io/en/stable/](https://nova-application-development.readthedocs.io/projects/nova-trame/en/stable/).
 
 Developers: please read [this document](DEVELOPMENT.md)
 

{nova_trame-0.22.0.dist-info → nova_trame-0.22.1.dist-info}/RECORD

@@ -25,15 +25,16 @@ nova/trame/view/theme/assets/js/delay_manager.js,sha256=mRV6KoO8-Bxq3tG5Bh9CQYy-
 nova/trame/view/theme/assets/js/lodash.min.js,sha256=KCyAYJ-fsqtp_HMwbjhy6IKjlA5lrVrtWt1JdMsC57k,73016
 nova/trame/view/theme/assets/js/revo_grid.js,sha256=WBsmoslu9qI5DHZkHkJam2AVgdiBp6szfOSV8a9cA5Q,3579
 nova/trame/view/theme/assets/vuetify_config.json,sha256=a0FSgpLYWGFlRGSMhMq61MyDFBEBwvz55G4qjkM08cs,5627
-nova/trame/view/theme/theme.py,sha256=0KzBJgAZRwlnwzCIf7gUjDY-gbhON7b2h3CMh2_9HY4,11746
+nova/trame/view/theme/exit_button.py,sha256=Kqv1GVJZGrSsj6_JFjGU3vm3iNuMolLC2T1x2IsdmV0,3094
+nova/trame/view/theme/theme.py,sha256=8JqSrEbhxK1SccXE1_jUdel9Wtc2QNObVEwtbVWG_QY,13146
 nova/trame/view/utilities/local_storage.py,sha256=vD8f2VZIpxhIKjZwEaD7siiPCTZO4cw9AfhwdawwYLY,3218
 nova/trame/view_model/data_selector.py,sha256=RyMHml1K_pupH4JtXnGxAaYTYYwNoEVus7Abdpqwueo,3698
 nova/trame/view_model/execution_buttons.py,sha256=MfKSp95D92EqpD48C15cBo6dLO0Yld4FeRZMJNxJf7Y,3551
 nova/trame/view_model/progress_bar.py,sha256=6AUKHF3hfzbdsHqNEnmHRgDcBKY5TT8ywDx9S6ovnsc,2854
 nova/trame/view_model/remote_file_input.py,sha256=ojEOJ8ZPkajpbAaZi9VLj7g-uBjhb8BMrTdMmwf_J6A,3367
 nova/trame/view_model/tool_outputs.py,sha256=ev6LY7fJ0H2xAJn9f5ww28c8Kpom2SYc2FbvFcoN4zg,829
-nova_trame-0.22.0.dist-info/LICENSE,sha256=Iu5QiDbwNbREg75iYaxIJ_V-zppuv4QFuBhAW-qiAlM,1061
-nova_trame-0.22.0.dist-info/METADATA,sha256=7ySWYYUkEE99UeZnMvMMwskNWHHhHjrrNv0_5dYRU0s,1603
-nova_trame-0.22.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-nova_trame-0.22.0.dist-info/entry_points.txt,sha256=J2AmeSwiTYZ4ZqHHp9HO6v4MaYQTTBPbNh6WtoqOT58,42
-nova_trame-0.22.0.dist-info/RECORD,,
+nova_trame-0.22.1.dist-info/LICENSE,sha256=Iu5QiDbwNbREg75iYaxIJ_V-zppuv4QFuBhAW-qiAlM,1061
+nova_trame-0.22.1.dist-info/METADATA,sha256=A-wOqVcFQXeV1qpuPJv253RugeWK5j2UryAUYdwgtII,1689
+nova_trame-0.22.1.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+nova_trame-0.22.1.dist-info/entry_points.txt,sha256=J2AmeSwiTYZ4ZqHHp9HO6v4MaYQTTBPbNh6WtoqOT58,42
+nova_trame-0.22.1.dist-info/RECORD,,