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

nova/trame/model/data_selector.py

@@ -2,7 +2,7 @@
 
 import os
 from pathlib import Path
-from typing import Any, List, Optional
+from typing import Any, Dict, List, Optional
 from warnings import warn
 
 from natsort import natsorted
@@ -140,7 +140,7 @@ class DataSelectorModel:
 
         return natsorted(experiments)
 
-    def sort_directories(self, directories: List[Any]) -> List[Any]:
+    def sort_directories(self, directories: List[Dict[str, Any]]) -> List[Dict[str, Any]]:
         # Sort the current level of dictionaries
         sorted_dirs = natsorted(directories, key=lambda x: x["title"])
 
@@ -164,9 +164,11 @@ class DataSelectorModel:
 
         return Path(self.state.custom_directory)
 
-    def get_directories(self) -> List[str]:
+    def get_directories(self, base_path: Optional[Path] = None) -> List[Dict[str, Any]]:
         using_custom_directory = self.state.facility == CUSTOM_DIRECTORIES_LABEL
-        if using_custom_directory:
+        if base_path:
+            pass
+        elif using_custom_directory:
             base_path = self.get_custom_directory_path()
         else:
             base_path = self.get_experiment_directory_path()
@@ -176,34 +178,31 @@ class DataSelectorModel:
 
         directories = []
         try:
-            if using_custom_directory:
-                for entry in os.listdir(base_path):
-                    path = base_path / entry
-                    if os.path.isdir(path):
-                        directories.append({"path": str(path), "title": entry})
-            else:
-                for dirpath, _, _ in os.walk(base_path):
-                    # Get the relative path from the start path
-                    path_parts = os.path.relpath(dirpath, base_path).split(os.sep)
-
-                    # Only create a new entry for top-level directories
-                    if len(path_parts) == 1 and path_parts[0] != ".":  # This indicates a top-level directory
-                        current_dir = {"path": dirpath, "title": path_parts[0]}
-                        directories.append(current_dir)
-
-                    # Add subdirectories to the corresponding parent directory
-                    elif len(path_parts) > 1:
-                        current_level: Any = directories
-                        for part in path_parts[:-1]:  # Parent directories
-                            for item in current_level:
-                                if item["title"] == part:
-                                    if "children" not in item:
-                                        item["children"] = []
-                                    current_level = item["children"]
-                                    break
-
-                        # Add the last part (current directory) as a child
-                        current_level.append({"path": dirpath, "title": path_parts[-1]})
+            for dirpath, dirs, _ in os.walk(base_path):
+                # Get the relative path from the start path
+                path_parts = os.path.relpath(dirpath, base_path).split(os.sep)
+
+                if len(path_parts) > 1:
+                    dirs.clear()
+
+                # Only create a new entry for top-level directories
+                if len(path_parts) == 1 and path_parts[0] != ".":  # This indicates a top-level directory
+                    current_dir = {"path": dirpath, "title": path_parts[0]}
+                    directories.append(current_dir)
+
+                # Add subdirectories to the corresponding parent directory
+                elif len(path_parts) > 1:
+                    current_level: Any = directories
+                    for part in path_parts[:-1]:  # Parent directories
+                        for item in current_level:
+                            if item["title"] == part:
+                                if "children" not in item:
+                                    item["children"] = []
+                                current_level = item["children"]
+                                break
+
+                    # Add the last part (current directory) as a child
+                    current_level.append({"path": dirpath, "title": path_parts[-1]})
         except OSError:
             pass
 

nova/trame/view/components/data_selector.py

@@ -133,8 +133,10 @@ class DataSelector(datagrid.VGrid):
                             activatable=True,
                             active_strategy="single-independent",
                             classes="flex-1-0 h-0 overflow-y-auto",
+                            fluid=True,
                             item_value="path",
                             items=(self._directories_name,),
+                            click_open=(self._vm.expand_directory, "[$event.path]"),
                             update_activated=(self._vm.set_directory, "$event"),
                         )
                         vuetify.VListItem("No directories found", classes="flex-0-1 text-center", v_else=True)

nova/trame/view/theme/assets/core_style.scss

@@ -20,6 +20,14 @@ html {
     white-space: pre-wrap;
 }
 
+.nova-data-selector {
+    .v-list-group {
+        .v-treeview-item {
+            --indent-padding: 1em !important;
+        }
+    }
+}
+
 .nova-data-selector revo-grid {
     font-family: 'Roboto', sans-serif;
     font-size: 0.75rem !important;

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/view_model/data_selector.py

@@ -1,6 +1,7 @@
 """View model implementation for the DataSelector widget."""
 
 import os
+from pathlib import Path
 from typing import Any, Dict, List, Optional
 
 from nova.mvvm.interface import BindingInterface
@@ -14,6 +15,8 @@ class DataSelectorViewModel:
         self.model = model
 
         self.datafiles: List[Dict[str, Any]] = []
+        self.directories: List[Dict[str, Any]] = []
+        self.expanded: List[str] = []
 
         self.state_bind = binding.new_bind(self.model.state, callback_after_update=self.on_state_updated)
         self.facilities_bind = binding.new_bind()
@@ -23,6 +26,30 @@ class DataSelectorViewModel:
         self.datafiles_bind = binding.new_bind()
         self.reset_bind = binding.new_bind()
 
+    def expand_directory(self, paths: List[str]) -> None:
+        if paths[-1] in self.expanded:
+            return
+
+        # Query for the new subdirectories to display in the view
+        new_directories = self.model.get_directories(Path(paths[-1]))
+
+        # Find the entry in the existing directories that corresponds to the directory to expand
+        current_level: Dict[str, Any] = {}
+        children: List[Dict[str, Any]] = self.directories
+        for current_path in paths:
+            if current_level:
+                children = current_level["children"]
+
+            for entry in children:
+                if current_path == entry["path"]:
+                    current_level = entry
+                    break
+        current_level["children"] = new_directories
+
+        # Mark this directory as expanded and display the new content
+        self.expanded.append(paths[-1])
+        self.directories_bind.update_in_view(self.directories)
+
     def set_directory(self, directory_path: str = "") -> None:
         self.model.set_directory(directory_path)
         self.update_view()
@@ -33,6 +60,8 @@ class DataSelectorViewModel:
 
     def reset(self) -> None:
         self.model.set_directory("")
+        self.directories = self.model.get_directories()
+        self.expanded = []
         self.reset_bind.update_in_view(None)
 
     def on_state_updated(self, results: Dict[str, Any]) -> None:
@@ -55,7 +84,7 @@ class DataSelectorViewModel:
         self.facilities_bind.update_in_view(self.model.get_facilities())
         self.instruments_bind.update_in_view(self.model.get_instruments())
         self.experiments_bind.update_in_view(self.model.get_experiments())
-        self.directories_bind.update_in_view(self.model.get_directories())
+        self.directories_bind.update_in_view(self.directories)
 
         self.datafiles = [
             {"path": datafile, "title": os.path.basename(datafile)} for datafile in self.model.get_datafiles()

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: nova-trame
-Version: 0.21.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.21.0.dist-info → nova_trame-0.22.1.dist-info}/RECORD

@@ -1,9 +1,9 @@
 nova/__init__.py,sha256=ED6jHcYiuYpr_0vjGz0zx2lrrmJT9sDJCzIljoDfmlM,65
 nova/trame/__init__.py,sha256=gFrAg1qva5PIqR5TjvPzAxLx103IKipJLqp3XXvrQL8,59
-nova/trame/model/data_selector.py,sha256=wIskRs3IzRgfXPT3jBJFYAAy3vy8wfX-gTyUNbmh89w,9101
+nova/trame/model/data_selector.py,sha256=UnLBCp_jJ523QxTR3R8iun2Ogq4D0G0lxmtW9e_zwOM,8938
 nova/trame/model/remote_file_input.py,sha256=9KAf31ZHzpsh_aXUrNcF81Q5jvUZDWCzW1QATKls-Jk,3675
 nova/trame/view/components/__init__.py,sha256=60BeS69aOrFnkptjuD17rfPE1f4Z35iBH56TRmW5MW8,451
-nova/trame/view/components/data_selector.py,sha256=sAA0v9lLhqkuC4WqRYe8c_banXz8ZOZEgf24NzG5Kjk,11097
+nova/trame/view/components/data_selector.py,sha256=lgZjyT_jc3eE19HNgz_Hdog5bWvXZJ3IfxxiSBkZ7hE,11222
 nova/trame/view/components/execution_buttons.py,sha256=fIkrWKI3jFZqk3GHhtmYh3nK2c-HOXpD3D3zd_TUpi0,4049
 nova/trame/view/components/file_upload.py,sha256=7VcpfA6zmiqMDLkwVPlb35Tf0IUTBN1xsHpoUFnSr1w,3111
 nova/trame/view/components/input_field.py,sha256=q6WQ_N-BOlimUL9zgazDlsDfK28FrrKjH4he8e_HzRA,16088
@@ -19,21 +19,22 @@ nova/trame/view/layouts/hbox.py,sha256=qlOMp_iOropIkC9Jxa6D89b7OPv0pNvJ73tUEzddy
 nova/trame/view/layouts/utils.py,sha256=Hg34VQWTG3yHBsgNvmfatR4J-uL3cko7UxSJpT-h3JI,376
 nova/trame/view/layouts/vbox.py,sha256=hzhzPu99R2fAclMe-FwHZseJWk7iailZ31bKdGhi1hk,3514
 nova/trame/view/theme/__init__.py,sha256=70_marDlTigIcPEOGiJb2JTs-8b2sGM5SlY7XBPtBDM,54
-nova/trame/view/theme/assets/core_style.scss,sha256=K-0lz-bHSeIqKWWx-e6YyRiGMhxW850rT811M_Z9A4g,3947
+nova/trame/view/theme/assets/core_style.scss,sha256=lK86Fp55oAMDh1eUHA-DTeGGZi0uUYOseIyJUTj-0A0,4081
 nova/trame/view/theme/assets/favicon.png,sha256=Xbp1nUmhcBDeObjsebEbEAraPDZ_M163M_ZLtm5AbQc,1927
 nova/trame/view/theme/assets/js/delay_manager.js,sha256=mRV6KoO8-Bxq3tG5Bh9CQYy-CRVbkj3IYlqNb-Og7cI,526
 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=llI7u8121R78dkecS4D2OI604LWlpByWn7OL9cckI9Q,2561
+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.21.0.dist-info/LICENSE,sha256=Iu5QiDbwNbREg75iYaxIJ_V-zppuv4QFuBhAW-qiAlM,1061
-nova_trame-0.21.0.dist-info/METADATA,sha256=5CG-2qrSc-0EGDteFilNzFjbtlm_k8oZTYx8XLPv63o,1603
-nova_trame-0.21.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-nova_trame-0.21.0.dist-info/entry_points.txt,sha256=J2AmeSwiTYZ4ZqHHp9HO6v4MaYQTTBPbNh6WtoqOT58,42
-nova_trame-0.21.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,,