nova-trame 0.19.1__py3-none-any.whl → 0.20.0__py3-none-any.whl

nova/trame/view/components/execution_buttons.py

@@ -0,0 +1,109 @@
+"""Module for the Progress Tab."""
+
+from trame.app import get_server
+from trame.widgets import client
+from trame.widgets import vuetify3 as vuetify
+from trame_client.widgets import html
+
+from nova.mvvm.trame_binding import TrameBinding
+from nova.trame.view_model.execution_buttons import ExecutionButtonsViewModel
+
+
+class ExecutionButtons:
+    """Execution buttons class. Adds Run/Stop/Cancel/Download buttons to the view."""
+
+    def __init__(self, id: str, stop_btn: bool = False, download_btn: bool = False) -> None:
+        """Constructor for ExecutionButtons.
+
+        Parameters
+        ----------
+        id : str
+            Component id. Should be used consistently with ToolRunner and other components
+        stop_btn: bool
+            Display stop button.
+        download_btn : bool
+            Display download button.
+
+        Returns
+        -------
+        None
+        """
+        self.id = f"execution_{id}"
+
+        self.server = get_server(None, client_type="vue3")
+        binding = TrameBinding(self.server.state)
+        self.ctrl = self.server.controller
+        self.stop_btn = stop_btn
+        self.download_btn = download_btn
+        self.view_model = ExecutionButtonsViewModel(id, binding)
+        self.view_model.buttons_state_bind.connect(self.id)
+        self._download = client.JSEval(
+            exec=(
+                "async ($event) => {"
+                " const blob = new window.Blob([$event], {type: 'application/zip'});"
+                "  const url = window.URL.createObjectURL(blob);"
+                "  const anchor = window.document.createElement('a');"
+                "  anchor.setAttribute('href', url);"
+                "  anchor.setAttribute('download', 'results.zip');"
+                "  window.document.body.appendChild(anchor);"
+                "  anchor.click();"
+                "  window.document.body.removeChild(anchor);"
+                "  setTimeout(() => window.URL.revokeObjectURL(url), 1000);"
+                "}"
+            )
+        ).exec
+
+        self.create_ui()
+
+    def create_ui(self) -> None:
+        with html.Div(classes="d-flex justify-center my-4 w-100"):
+            vuetify.VBtn(
+                "Run",
+                disabled=(f"{self.id}.run_disabled",),
+                prepend_icon="mdi-play",
+                classes="mr-4",
+                id=f"{self.id}_run",
+                click=self.run,
+            )
+            if self.stop_btn:
+                vuetify.VBtn(
+                    "Stop",
+                    disabled=(f"{self.id}.stop_disabled",),
+                    loading=(f"{self.id}.stop_in_progress",),
+                    classes="mr-4",
+                    id=f"{self.id}_stop",
+                    prepend_icon="mdi-stop",
+                    click=self.stop,
+                )
+            vuetify.VBtn(
+                "Cancel",
+                disabled=(f"{self.id}.cancel_disabled",),
+                color="error",
+                loading=(f"{self.id}.cancel_in_progress",),
+                prepend_icon="mdi-cancel",
+                classes="mr-4",
+                id=f"{self.id}_cancel",
+                click=self.cancel,
+            )
+            if self.download_btn:
+                vuetify.VBtn(
+                    "Download Results",
+                    disabled=(f"{self.id}.download_disabled",),
+                    loading=(f"{self.id}.download_in_progress",),
+                    id=f"{self.id}.download",
+                    click=self.download,
+                )
+
+    async def download(self) -> None:
+        content = await self.view_model.prepare_results()
+        if content:
+            self._download(content)
+
+    async def run(self) -> None:
+        await self.view_model.run()
+
+    async def cancel(self) -> None:
+        await self.view_model.cancel()
+
+    async def stop(self) -> None:
+        await self.view_model.stop()

nova/trame/view/components/input_field.py

@@ -290,7 +290,7 @@ class InputField:
                 )
             ).exec
 
-            @state.change(input.v_model)
+            @state.change(input.v_model.split(".")[0])
             def _autoscroll(**kwargs: Any) -> None:
                 autoscroll(input.id)
 

nova/trame/view/components/progress_bar.py

@@ -0,0 +1,62 @@
+"""Module for the Progress Tab."""
+
+from trame.app import get_server
+from trame.widgets import vuetify3 as vuetify
+from trame_client.widgets import html
+
+from nova.mvvm.trame_binding import TrameBinding
+from nova.trame.view_model.progress_bar import ProgressBarViewModel
+
+
+class ProgressBar:
+    """Progress bar class. Adds progress bar that displays job status to the view."""
+
+    def __init__(self, id: str) -> None:
+        """Constructor for ProgressBar.
+
+        Parameters
+        ----------
+        id : str
+            Component id. Should be used consistently with ToolRunner and other components
+
+        Returns
+        -------
+        None
+        """
+        self.id = f"progress_bar_{id}"
+        self.create_viewmodel(id)
+        self.view_model.progress_state_bind.connect(self.id)
+        self.create_ui()
+
+    def create_viewmodel(self, id: str) -> None:
+        server = get_server(None, client_type="vue3")
+        binding = TrameBinding(server.state)
+        self.view_model = ProgressBarViewModel(id, binding)
+
+    def create_ui(self) -> None:
+        with vuetify.VProgressLinear(
+            height="25",
+            model_value=(f"{self.id}.progress", "0"),
+            striped=True,
+            id=f"{self.id}_show_progress",
+            v_show=(f"{self.id}.show_progress",),
+        ):
+            html.H5(v_text=f"{self.id}.details")
+        with vuetify.VProgressLinear(
+            height="25",
+            model_value="100",
+            striped=False,
+            color="error",
+            id=f"{self.id}_show_failed",
+            v_show=(f"{self.id}.show_failed",),
+        ):
+            html.H5(v_text=f"{self.id}.details", classes="text-white")
+        with vuetify.VProgressLinear(
+            height="25",
+            model_value="100",
+            striped=False,
+            color="primary",
+            id=f"{self.id}_show_ok",
+            v_show=(f"{self.id}.show_ok",),
+        ):
+            html.H5(v_text=f"{self.id}.details", classes="text-white")

nova/trame/view/components/tool_outputs.py

@@ -0,0 +1,60 @@
+"""Module for the Tool outputs."""
+
+from trame.app import get_server
+from trame.widgets import vuetify3 as vuetify
+
+from nova.mvvm.trame_binding import TrameBinding
+from nova.trame.view.components import InputField
+from nova.trame.view.layouts import HBoxLayout
+from nova.trame.view_model.tool_outputs import ToolOutputsViewModel
+
+
+class ToolOutputWindows:
+    """Tool outputs class. Displays windows with tool stdout/stderr."""
+
+    def __init__(self, id: str) -> None:
+        """Constructor for ToolOutputWindows.
+
+        Parameters
+        ----------
+        id : str
+            Component id. Should be used consistently with ToolRunner and other components
+
+        Returns
+        -------
+        None
+        """
+        self.id = f"tool_outputs_{id}"
+        self.create_viewmodel(id)
+        self.view_model.tool_outputs_bind.connect(self.id)
+        self.create_ui()
+
+    def create_viewmodel(self, id: str) -> None:
+        server = get_server(None, client_type="vue3")
+        binding = TrameBinding(server.state)
+        self.view_model = ToolOutputsViewModel(id, binding)
+
+    def create_ui(self) -> None:
+        with HBoxLayout(classes="d-flex", width="100%"):
+            with vuetify.VTabs(v_model=(f"{self.id}_active_output_tab", "1"), direction="vertical"):
+                vuetify.VTab("Console output", value=1)
+                vuetify.VTab("Console error", value=2)
+            with HBoxLayout(classes="flex-grow-1"):
+                InputField(
+                    v_show=f"{self.id}_active_output_tab === '1'",
+                    v_model=f"{self.id}.stdout",
+                    id=f"{self.id}_outputs",
+                    type="autoscroll",
+                    auto_grow=True,
+                    readonly=True,
+                    max_rows="30",
+                )
+                InputField(
+                    v_show=f"{self.id}_active_output_tab === '2'",
+                    v_model=f"{self.id}.stderr",
+                    id=f"{self.id}_errors",
+                    type="autoscroll",
+                    auto_grow=True,
+                    readonly=True,
+                    max_rows="30",
+                )

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

@@ -130,10 +130,14 @@ html {
         min-width: 0px !important;
         padding: 5px 5px !important;
         box-shadow: none !important;
-    }
 
-    .v-btn__content {
-        text-transform: none;
+        .v-btn__content {
+            text-transform: none;
+        }
+
+        .v-btn__prepend {
+            margin-left: 1px;
+        }
     }
 
     .v-label {
@@ -145,6 +149,10 @@ html {
         padding: 5px;
     }
 
+    textarea.v-field__input {
+        mask-image: none !important;
+    }
+
     .v-field {
         margin: 8px 4px 8px 4px;
     }

nova/trame/view_model/execution_buttons.py

@@ -0,0 +1,87 @@
+"""Module for the JobProgress ViewModel."""
+
+import asyncio
+from typing import Any, Optional
+
+import blinker
+from pydantic import BaseModel
+
+from nova.common.job import WorkState
+from nova.common.signals import Signal, ToolCommand, get_signal_id
+from nova.mvvm.interface import BindingInterface
+
+
+def job_running(status: WorkState) -> bool:
+    """A helper function to check if job is doing something in Galaxy."""
+    return status in [
+        WorkState.UPLOADING_DATA,
+        WorkState.QUEUED,
+        WorkState.RUNNING,
+        WorkState.STOPPING,
+        WorkState.CANCELING,
+    ]
+
+
+class ButtonsState(BaseModel):
+    """Class that manages start/stop/cancel button states."""
+
+    run_disabled: bool = False
+    cancel_disabled: bool = True
+    stop_disabled: bool = True
+    download_disabled: bool = True
+
+    stop_in_progress: bool = False
+    cancel_in_progress: bool = False
+    download_in_progress: bool = False
+
+    def update_from_workstate(self, status: WorkState) -> None:
+        running = job_running(status)
+        self.run_disabled = running
+        self.cancel_disabled = not running
+        self.stop_disabled = status not in [WorkState.RUNNING, WorkState.STOPPING]
+        self.stop_in_progress = status == WorkState.STOPPING
+        self.cancel_in_progress = status == WorkState.CANCELING
+        self.download_disabled = status != WorkState.FINISHED
+
+
+class ExecutionButtonsViewModel:
+    """A viewmodel responsible for execution buttons."""
+
+    def __init__(self, id: str, binding: BindingInterface):
+        self.sender_id = f"ExecutionButtonsViewModel_{id}"
+        self.button_states = ButtonsState()
+        self.buttons_state_bind = binding.new_bind(self.button_states)
+        self.execution_signal = blinker.signal(get_signal_id(id, Signal.TOOL_COMMAND))
+        self.progress_signal = blinker.signal(get_signal_id(id, Signal.PROGRESS))
+        self.progress_signal.connect(self.update_state, weak=False)
+
+    async def update_state(self, _sender: Any, state: WorkState, details: str) -> None:
+        self.button_states.update_from_workstate(state)
+        self.buttons_state_bind.update_in_view(self.button_states)
+
+    async def run(self) -> None:
+        # disable run now since it might take some time before the client updates the status
+        self.button_states.run_disabled = True
+        self.buttons_state_bind.update_in_view(self.button_states)
+        await self.execution_signal.send_async(self.sender_id, command=ToolCommand.START)
+
+    async def cancel(self) -> None:
+        await self.execution_signal.send_async(self.sender_id, command=ToolCommand.CANCEL)
+
+    async def stop(self) -> None:
+        await self.execution_signal.send_async(self.sender_id, command=ToolCommand.CANCEL)
+
+    async def prepare_results(self) -> Optional[bytes]:
+        self.button_states.download_in_progress = True
+        self.buttons_state_bind.update_in_view(self.button_states)
+        await asyncio.sleep(0.5)  # to give Trame time to update view
+        responses = await self.execution_signal.send_async(self.sender_id, command=ToolCommand.GET_RESULTS)
+        res = None
+        for response in responses:  # responses can come from multiple places
+            if response[1] is None:
+                continue
+            if response[1]["sender"] == self.sender_id and response[1]["command"] == ToolCommand.GET_RESULTS:
+                res = response[1]["results"]
+        self.button_states.download_in_progress = False
+        self.buttons_state_bind.update_in_view(self.button_states)
+        return res

nova/trame/view_model/progress_bar.py

@@ -0,0 +1,75 @@
+"""Module for the JobProgress ViewModel."""
+
+from typing import Any
+
+import blinker
+from pydantic import BaseModel
+
+from nova.common.job import WorkState
+from nova.common.signals import Signal, get_signal_id
+from nova.mvvm.interface import BindingInterface
+
+
+def details_from_state(state: WorkState) -> str:
+    work_state_map = {
+        WorkState.NOT_STARTED: "job not started",
+        WorkState.UPLOADING_DATA: "uploading data",
+        WorkState.QUEUED: "job is queued",
+        WorkState.RUNNING: "job is running",
+        WorkState.FINISHED: "job finished",
+        WorkState.ERROR: "job produced an error",
+        WorkState.DELETED: "job deleted",
+        WorkState.CANCELED: "job canceled",
+        WorkState.STOPPING: "stopping job",
+        WorkState.CANCELING: "canceling job",
+    }
+    if state in work_state_map:
+        return work_state_map[state]
+    else:
+        return state.value
+
+
+class ProgressState(BaseModel):
+    """Class that manages progress bars states."""
+
+    progress: str = ""
+    details: str = ""
+    show_progress: bool = False
+    show_failed: bool = False
+    show_ok: bool = False
+
+    def update_from_workstate(self, state: WorkState) -> None:
+        progress = "0"
+        match state:
+            case WorkState.UPLOADING_DATA:
+                progress = "10"
+            case WorkState.QUEUED:
+                progress = "20"
+            case WorkState.RUNNING:
+                progress = "50"
+
+        self.show_progress = state in [
+            WorkState.UPLOADING_DATA,
+            WorkState.QUEUED,
+            WorkState.RUNNING,
+            WorkState.CANCELING,
+            WorkState.STOPPING,
+        ]
+        self.show_failed = state == WorkState.ERROR
+        self.show_ok = state == WorkState.FINISHED
+        self.progress = progress
+        self.details = details_from_state(state)
+
+
+class ProgressBarViewModel:
+    """A viewmodel responsible for progress bar."""
+
+    def __init__(self, id: str, binding: BindingInterface):
+        self.progress_state = ProgressState()
+        self.progress_state_bind = binding.new_bind(self.progress_state)
+        self.progress_signal = blinker.signal(get_signal_id(id, Signal.PROGRESS))
+        self.progress_signal.connect(self.update_state, weak=False)
+
+    async def update_state(self, _sender: Any, state: WorkState, details: str) -> None:
+        self.progress_state.update_from_workstate(state)
+        self.progress_state_bind.update_in_view(self.progress_state)

nova/trame/view_model/tool_outputs.py

@@ -0,0 +1,23 @@
+"""Module for the Tool ouputs ViewModel."""
+
+from typing import Any
+
+import blinker
+
+from nova.common.job import ToolOutputs
+from nova.common.signals import Signal, get_signal_id
+from nova.mvvm.interface import BindingInterface
+
+
+class ToolOutputsViewModel:
+    """A viewmodel responsible for tool stdout and stderr."""
+
+    def __init__(self, id: str, binding: BindingInterface):
+        self.tool_outputs = ToolOutputs()
+        self.tool_outputs_bind = binding.new_bind(self.tool_outputs)
+        self.outputs_signal = blinker.signal(get_signal_id(id, Signal.OUTPUTS))
+        self.outputs_signal.connect(self.on_outputs_update, weak=False)
+
+    async def on_outputs_update(self, _sender: Any, outputs: ToolOutputs) -> None:
+        self.tool_outputs = outputs
+        self.tool_outputs_bind.update_in_view(self.tool_outputs)

{nova_trame-0.19.1.dist-info → nova_trame-0.20.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: nova-trame
-Version: 0.19.1
+Version: 0.20.0
 Summary: A Python Package for injecting curated themes and custom components into Trame applications
 License: MIT
 Keywords: NDIP,Python,Trame,Vuetify
@@ -14,8 +14,10 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: altair
+Requires-Dist: blinker (>=1.9.0,<2.0.0)
 Requires-Dist: libsass
 Requires-Dist: mergedeep
+Requires-Dist: nova-common (>=0.2.0)
 Requires-Dist: nova-mvvm
 Requires-Dist: pydantic
 Requires-Dist: tomli

{nova_trame-0.19.1.dist-info → nova_trame-0.20.0.dist-info}/RECORD

@@ -4,9 +4,12 @@ nova/trame/model/data_selector.py,sha256=sCLU0YIMCccC1BH8dKZPmajaft6WgwuM_zOr3NP
 nova/trame/model/remote_file_input.py,sha256=9KAf31ZHzpsh_aXUrNcF81Q5jvUZDWCzW1QATKls-Jk,3675
 nova/trame/view/components/__init__.py,sha256=u8yzshFp_TmuC1g9TRxKjy_BdGWMIzPQouI52hzcr2U,234
 nova/trame/view/components/data_selector.py,sha256=UFQriSH25wk3F4s6EnP5Dfrt3MFbisJTrzmRxH0ME8U,8831
+nova/trame/view/components/execution_buttons.py,sha256=wXpgF6osuAivKKnby8yCevoFa4PbRlCtUgEymjiugzE,3857
 nova/trame/view/components/file_upload.py,sha256=7VcpfA6zmiqMDLkwVPlb35Tf0IUTBN1xsHpoUFnSr1w,3111
-nova/trame/view/components/input_field.py,sha256=Wf-WuYm9SmbHXYy1cvYy8zDWe5rhvLcUHmwqmBvqVxk,16074
+nova/trame/view/components/input_field.py,sha256=q6WQ_N-BOlimUL9zgazDlsDfK28FrrKjH4he8e_HzRA,16088
+nova/trame/view/components/progress_bar.py,sha256=vva_blYZwF1xJt72sCBSbJB5HloyTy39UoVOP_ixs_E,1995
 nova/trame/view/components/remote_file_input.py,sha256=ByrBFj8svyWezcardCWrS_4Ag3fgTYNg_11lDW1FIA8,9669
+nova/trame/view/components/tool_outputs.py,sha256=IlpvJJuVZ6o9WMXW1Hpsvca7Xw1AxO83fdr_JFcYnbA,2146
 nova/trame/view/components/visualization/__init__.py,sha256=reqkkbhD5uSksHHlhVMy1qNUCwSekS5HlXk6wCREYxU,152
 nova/trame/view/components/visualization/interactive_2d_plot.py,sha256=foZCMoqbuahT5dtqIQvm8C4ZJcY9P211eJEcpQJltmM,3421
 nova/trame/view/components/visualization/matplotlib_figure.py,sha256=0iWCXB8i7Tut1gA66hY9cGrhZPaHC7p-XdADDNy_UVY,12042
@@ -16,7 +19,7 @@ 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=kxm66OdHeSAW1_zWJXWpzBZ30hopI1cgLwyXrqdmf1I,3214
+nova/trame/view/theme/assets/core_style.scss,sha256=5i2cZQbmaQTpcNgsaVRdcubh0HHidqPnnLj8McHNkbY,3367
 nova/trame/view/theme/assets/favicon.png,sha256=Xbp1nUmhcBDeObjsebEbEAraPDZ_M163M_ZLtm5AbQc,1927
 nova/trame/view/theme/assets/js/delay_manager.js,sha256=vmb34DZ5YCQIlRW9Tf2M_uvJW6HFCmtlKZ5e_TPR8yg,536
 nova/trame/view/theme/assets/js/lodash.debounce.min.js,sha256=GLzlQH04WDUNYN7i39ttHHejSdu-CpAvfWgDgKDn-OY,4448
@@ -25,9 +28,12 @@ nova/trame/view/theme/assets/vuetify_config.json,sha256=a0FSgpLYWGFlRGSMhMq61MyD
 nova/trame/view/theme/theme.py,sha256=HUeuVfzEgeYW65W-LcvXzfYNRHu6aQibGwwgHGyh3OA,11765
 nova/trame/view/utilities/local_storage.py,sha256=vD8f2VZIpxhIKjZwEaD7siiPCTZO4cw9AfhwdawwYLY,3218
 nova/trame/view_model/data_selector.py,sha256=FM1Xe-f-gi1jVwA9nDf2KE1UDvsAvmMKlp78slIpX58,2418
+nova/trame/view_model/execution_buttons.py,sha256=MfKSp95D92EqpD48C15cBo6dLO0Yld4FeRZMJNxJf7Y,3551
+nova/trame/view_model/progress_bar.py,sha256=L7ED6TDn5v2142iu-qt3i-jUg_5JEhLyC476t2OtohU,2467
 nova/trame/view_model/remote_file_input.py,sha256=ojEOJ8ZPkajpbAaZi9VLj7g-uBjhb8BMrTdMmwf_J6A,3367
-nova_trame-0.19.1.dist-info/LICENSE,sha256=Iu5QiDbwNbREg75iYaxIJ_V-zppuv4QFuBhAW-qiAlM,1061
-nova_trame-0.19.1.dist-info/METADATA,sha256=KAU_st5MU5BO6fNu45_wh3J-DP8QwKastiWR2cCRpnA,1446
-nova_trame-0.19.1.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
-nova_trame-0.19.1.dist-info/entry_points.txt,sha256=J2AmeSwiTYZ4ZqHHp9HO6v4MaYQTTBPbNh6WtoqOT58,42
-nova_trame-0.19.1.dist-info/RECORD,,
+nova/trame/view_model/tool_outputs.py,sha256=ev6LY7fJ0H2xAJn9f5ww28c8Kpom2SYc2FbvFcoN4zg,829
+nova_trame-0.20.0.dist-info/LICENSE,sha256=Iu5QiDbwNbREg75iYaxIJ_V-zppuv4QFuBhAW-qiAlM,1061
+nova_trame-0.20.0.dist-info/METADATA,sha256=0URjV5ll_dfW8d0kB_EnpCa0ttbNEObIsk0J8HevEu0,1523
+nova_trame-0.20.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+nova_trame-0.20.0.dist-info/entry_points.txt,sha256=J2AmeSwiTYZ4ZqHHp9HO6v4MaYQTTBPbNh6WtoqOT58,42
+nova_trame-0.20.0.dist-info/RECORD,,

{nova_trame-0.19.1.dist-info → nova_trame-0.20.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.1.2
+Generator: poetry-core 2.1.3
 Root-Is-Purelib: true
 Tag: py3-none-any