nova-trame 0.27.0__py3-none-any.whl → 1.0.0__py3-none-any.whl

nova/trame/view/components/data_selector.py

@@ -129,7 +129,7 @@ class DataSelector(datagrid.VGrid):
         return get_server(None, client_type="vue3").state
 
     def create_ui(self, *args: Any, **kwargs: Any) -> None:
-        with VBoxLayout(classes="nova-data-selector", height="100%") as self._layout:
+        with VBoxLayout(classes="nova-data-selector", stretch=True) as self._layout:
             with HBoxLayout(valign="center"):
                 self._layout.filter = html.Div(classes="flex-1-1")
                 with vuetify.VBtn(
@@ -138,9 +138,9 @@ class DataSelector(datagrid.VGrid):
                     vuetify.VIcon("mdi-refresh")
                     vuetify.VTooltip("Refresh Contents", activator="parent")
 
-            with GridLayout(columns=2, classes="flex-1-0 h-0", valign="start"):
+            with GridLayout(columns=2, stretch=True):
                 if isinstance(self._subdirectory, tuple) or not self._subdirectory:
-                    with html.Div(classes="d-flex flex-column h-100 overflow-hidden"):
+                    with VBoxLayout(stretch=True):
                         vuetify.VListSubheader("Available Directories", classes="flex-0-1 justify-center px-0")
                         vuetify.VTreeview(
                             v_if=(f"{self._directories_name}.length > 0",),

nova/trame/view/components/ornl/neutron_data_selector.py

@@ -292,6 +292,8 @@ class NeutronDataSelector(DataSelector):
                         projection=set_state_param(self.state, self._projection, projection)
                     )
 
+        super()._setup_bindings()
+
     # These update methods notify the rest of the application when the component changes bound parameters.
     def update_facility(self, facility: str) -> None:
         self._vm.set_binding_parameters(

nova/trame/view/components/visualization/matplotlib_figure.py

@@ -9,10 +9,11 @@ from mimetypes import types_map
 from pathlib import Path
 from threading import Thread
 from typing import Any, Optional
+from warnings import warn
 
 import tornado
 from aiohttp import ClientSession, WSMsgType, web
-from matplotlib import get_data_path
+from matplotlib import get_data_path, rcParams
 from matplotlib.backends.backend_webagg import FigureManagerWebAgg, new_figure_manager_given_figure  # type: ignore
 from matplotlib.figure import Figure
 from trame.app import get_server
@@ -55,7 +56,10 @@ class _MPLApplication(tornado.web.Application):
                 self.supports_binary = message["value"]
             else:
                 manager = self.application.manager  # type: ignore
-                manager.handle_json(message)
+                try:
+                    manager.handle_json(message)
+                except Exception:
+                    manager.refresh_all()
 
         def send_json(self, content: Any) -> None:
             set_event_loop(self.application.loop)  # type: ignore
@@ -69,6 +73,13 @@ class _MPLApplication(tornado.web.Application):
                 data_uri = "data:image/png;base64," + blob.encode("base64").replace("\n", "")
                 self.write_message(data_uri)
 
+        def write_message(self, *args: Any, **kwargs: Any) -> Any:
+            # We need the websocket to remain alive if a message fails to write.
+            try:
+                super().write_message(*args, **kwargs)
+            except Exception:
+                pass
+
     def __init__(self, figure: Figure) -> None:
         self.figure = figure
         self.manager = new_figure_manager_given_figure(id(figure), figure)
@@ -214,17 +225,22 @@ class MatplotlibFigure(matplotlib.Figure):
         -------
         None
         """  # noqa: E501
+        self._server = get_server(None, client_type="vue3")
         self._webagg = webagg
+        if "classes" in kwargs:
+            kwargs["classes"] += " flex-1-1"
+        else:
+            kwargs["classes"] = "flex-1-1"
         if webagg:
-            self._port = MatplotlibFigure._get_free_port()
-            if "classes" in kwargs:
-                kwargs["classes"] += " nova-mpl"
-            else:
-                kwargs["classes"] = "nova-mpl"
+            if "id" in kwargs:
+                kwargs.pop("id")
+                warn("id parameter to MatplotlibFigure is ignored when webagg=True.", stacklevel=1)
 
-            html.Div(id=f"nova_mpl_{self._port}", **kwargs)
+            self._port = MatplotlibFigure._get_free_port()
+            self._id = f"nova_mpl_{self._port}"
+            kwargs["classes"] += " nova-mpl"
 
-            self._server = get_server(None, client_type="vue3")
+            html.Div(id=self._id, **kwargs)
 
             self._figure = figure
             self._initialized = False
@@ -236,8 +252,63 @@ class MatplotlibFigure(matplotlib.Figure):
             self.update()
         else:
             super().__init__(figure, **kwargs)
-
-    def update(self, figure: Optional[Figure] = None) -> None:
+            self._id = self._key
+
+        self._query_selector = f"window.document.querySelector('#{self._id}')"
+        self._trigger = (
+            f"if ({self._query_selector} === null) {{ return; }}"
+            # webagg figures receive a fixed width and height. This blocks the flexbox scaling, so I temporarily hide
+            # the figure to allow the container to grow/shrink naturally in flexbox.
+            f"window.document.querySelectorAll('.nova-mpl').forEach((item) => {{ item.style.display = 'none'; }});"
+            f"const height = {self._query_selector}.parentNode.offsetHeight;"
+            f"const width = {self._query_selector}.parentNode.offsetWidth;"
+            # Revert the display value to allow the figure to render again.
+            f"window.document.querySelectorAll('.nova-mpl').forEach((item) => {{ item.style.display = ''; }});"
+            "window.trame.trigger("
+            f"  '{self._id}_resize',"
+            f"  [height, width]"
+            ");"
+        )
+        self._resize_figure = client.JSEval(exec=self._trigger).exec
+        self._resize_listener = client.JSEval(
+            exec=(
+                # ResizeObserver is necessary to detect changes in size unrelated to the viewport size such as when
+                # content is conditionally rendered that changes the size of the figure's container.
+                "const resizeObserver = new window.ResizeObserver(() => {"
+                f"  window.delay_manager.debounce('{self._id}', function() {{ {self._trigger} }}, 500);"
+                "});"
+                f"resizeObserver.observe({self._query_selector}.parentNode);"
+            )
+        ).exec
+
+        @self._server.controller.trigger(f"{self._id}_resize")
+        def resize_figure(height: int, width: int) -> None:
+            if self._figure:
+                if self._webagg:
+                    # Reserve space for the controls injected by webagg.
+                    height -= 48
+                    width -= 4
+
+                if height <= 0 or width <= 0:
+                    return
+
+                if self._webagg:
+                    # Webagg does not respect the Figure object's DPI.
+                    dpi = rcParams["figure.dpi"]
+                else:
+                    dpi = self._figure.get_dpi()
+                new_width = width / dpi
+                new_height = height / dpi
+                current_size = self._figure.get_size_inches()
+                if current_size[0] != new_width or current_size[1] != new_height:
+                    self._figure.set_size_inches(new_width, new_height)
+
+                self.update(skip_resize=True)
+
+        client.ClientTriggers(mounted=self._resize_listener)
+        client.ClientTriggers(mounted=self._resize_figure)
+
+    def update(self, figure: Optional[Figure] = None, skip_resize: bool = False) -> None:
         if self._webagg:
             if figure:
                 self._figure = figure
@@ -255,7 +326,10 @@ class MatplotlibFigure(matplotlib.Figure):
         else:
             super().update(figure)
 
-        self._server.state.flush()
+        if not skip_resize and hasattr(self, "_resize_figure"):
+            self._resize_figure()
+        else:
+            self._server.state.flush()
 
     def _setup_figure_websocket(self) -> None:
         thread = Thread(target=self._mpl_run_ws_server, daemon=True)

nova/trame/view/layouts/grid.py

@@ -1,6 +1,7 @@
 """Trame implementation of the GridLayout class."""
 
 from typing import Any, Optional, Union
+from warnings import warn
 
 from trame.widgets import html
 from trame_client.widgets.core import AbstractElement
@@ -19,6 +20,7 @@ class GridLayout(html.Div):
         halign: Optional[str] = None,
         valign: Optional[str] = None,
         gap: Optional[Union[int, str]] = "0em",
+        stretch: bool = False,
         **kwargs: Any,
     ) -> None:
         """Constructor for GridLayout.
@@ -38,10 +40,14 @@ class GridLayout(html.Div):
             <https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items>`__ for available options.
         valign : optional[str]
             The vertical alignment of items in the grid. See `MDN
-            <https://developer.mozilla.org/en-US/docs/Web/CSS/align-items>`__ for available options.
+            <https://developer.mozilla.org/en-US/docs/Web/CSS/align-items>`__ for available options. Note that this
+            parameter is ignored when stretch=True.
         gap : optional[str]
             The gap to place between items (works both horizontally and vertically). Can be any CSS gap value (e.g.
             "4px" or "0.25em"). Defaults to no gap between items.
+        stretch : optional[bool]
+            If True, then this layout component will stretch to attempt to fill the space of it's parent container.
+            Defaults to False.
         kwargs : Any
             Additional keyword arguments to pass to html.Div.
 
@@ -69,6 +75,13 @@ class GridLayout(html.Div):
         if isinstance(classes, list):
             classes = " ".join(classes)
         classes += " d-grid"
+        if stretch:
+            if valign:
+                warn("Ignoring valign parameter to GridLayout since stretch=True.", stacklevel=1)
+            valign = "stretch"
+            classes += " flex-1-1 overflow-y-auto"
+        else:
+            classes += " flex-0-1"
 
         widget_style = self.get_root_styles(columns, height, width, halign, valign, gap)
         user_style = kwargs.pop("style", {})

nova/trame/view/layouts/hbox.py

@@ -18,6 +18,7 @@ class HBoxLayout(html.Div):
         valign: Optional[str] = None,
         gap: Optional[Union[int, str]] = "0em",
         vspace: Optional[Union[int, str]] = "0em",
+        stretch: bool = False,
         **kwargs: Any,
     ) -> None:
         """Constructor for HBoxLayout.
@@ -42,6 +43,9 @@ class HBoxLayout(html.Div):
         vspace : optional[str]
             The vertical gap to place between items. Can be any CSS gap value (e.g. "4px" or "0.25em"). Defaults to no
             gap between items.
+        stretch : optional[bool]
+            If True, then this layout component will stretch to attempt to fill the space of it's parent container.
+            Defaults to False.
         kwargs : Any
             Additional keyword arguments to pass to html.Div.
 
@@ -60,6 +64,10 @@ class HBoxLayout(html.Div):
         if isinstance(classes, list):
             classes = " ".join(classes)
         classes += " d-flex flex-row"
+        if stretch:
+            classes += " flex-1-1 overflow-y-auto"
+        else:
+            classes += " flex-0-1"
 
         widget_style = self.get_root_styles(height, width, halign, valign, gap, vspace)
         user_style = kwargs.pop("style", {})

nova/trame/view/layouts/vbox.py

@@ -18,6 +18,7 @@ class VBoxLayout(html.Div):
         valign: Optional[str] = None,
         gap: Optional[Union[int, str]] = "0em",
         vspace: Optional[Union[int, str]] = "0em",
+        stretch: bool = False,
         **kwargs: Any,
     ) -> None:
         """Constructor for VBoxLayout.
@@ -42,6 +43,9 @@ class VBoxLayout(html.Div):
         vspace : optional[str]
             The vertical gap to place between items. Can be any CSS gap value (e.g. "4px" or "0.25em"). Defaults to no
             gap between items.
+        stretch : optional[bool]
+            If True, then this layout component will stretch to attempt to fill the space of it's parent container.
+            Defaults to False.
         kwargs : Any
             Additional keyword arguments to pass to html.Div.
 
@@ -60,6 +64,10 @@ class VBoxLayout(html.Div):
         if isinstance(classes, list):
             classes = " ".join(classes)
         classes += " d-flex flex-column"
+        if stretch:
+            classes += " flex-1-1 overflow-y-auto"
+        else:
+            classes += " flex-0-1"
 
         widget_style = self.get_root_styles(height, width, halign, valign, gap, vspace)
         user_style = kwargs.pop("style", {})

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

@@ -70,12 +70,24 @@ html {
 }
 
 .v-window {
+    display: flex;
+    flex: 1 1;
     overflow-x: visible !important;
     overflow-y: visible !important;
+
+    .v-window__container {
+        flex: 1 1;
+
+        .v-window-item {
+            flex: 1 1;
+        }
+    }
 }
 
 @media only screen and (max-width: 959px) {
     .d-grid {
+        /* This forces all grid rows to have the same height. If one doesn't want this to happen, then they should use the box layouts. :) */
+        grid-auto-rows: 1fr;
         grid-template-columns: repeat(1, 1fr) !important;
     }
 

nova/trame/view/theme/theme.py

@@ -288,11 +288,13 @@ class ThemedApp:
 
                     with vuetify.VMain(classes="align-stretch d-flex flex-column h-screen"):
                         # [slot override example]
-                        layout.pre_content = vuetify.VSheet(classes="bg-background ")
+                        layout.pre_content = vuetify.VSheet(classes="bg-background flex-0-1 mt-1 ")
                         # [slot override example complete]
-                        with vuetify.VContainer(classes="flex-0-1 overflow-hidden pt-0 pb-0", fluid=True):
-                            layout.content = html.Div(classes="h-100 overflow-y-auto pb-1 ")
-                        layout.post_content = vuetify.VSheet(classes="bg-background ")
+                        with vuetify.VContainer(classes="flex-1-1 overflow-hidden pt-0 pb-2", fluid=True):
+                            layout.content = vuetify.VCard(
+                                classes="d-flex flex-column flex-1-1 h-100 overflow-y-auto pa-1 "
+                            )
+                        layout.post_content = vuetify.VSheet(classes="bg-background flex-0-1 mb-1 ")
 
                     with vuetify.VFooter(
                         app=True,

{nova_trame-0.27.0.dist-info → nova_trame-1.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nova-trame
-Version: 0.27.0
+Version: 1.0.0
 Summary: A Python Package for injecting curated themes and custom components into Trame applications
 License-Expression: MIT
 License-File: LICENSE
@@ -38,7 +38,7 @@ Description-Content-Type: text/markdown
 nova-trame
 ==========
 
-`nova-trame` is a Python package for streamlining development of Trame applications used in the NOVA project.
+`nova-trame` is a Python package for streamlining development of Trame applications used in the NOVA framework.
 
 You can install this package directly with
 
@@ -46,6 +46,13 @@ You can install this package directly with
 pip install nova-trame
 ```
 
+Once installed, you can check that it's working by running the widget gallery we use for visually testing components available through NOVA and Trame. We use [Poetry](https://python-poetry.org/) internally and recommend it for running the gallery.
+
+```commandline
+poetry install
+poetry run app
+```
+
 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.27.0.dist-info → nova_trame-1.0.0.dist-info}/RECORD

@@ -7,32 +7,32 @@ nova/trame/model/ornl/neutron_data_selector.py,sha256=YMoNEpDKgjP_y18oYj-N9Ijkxt
 nova/trame/model/ornl/oncat_data_selector.py,sha256=3JEkWGMU-esWA9DUTglju9hEP9LyZ7EUXLj1yO5BIDs,4755
 nova/trame/model/remote_file_input.py,sha256=eAk7ZsFgNKcnpJ6KmOQDhiI6pPZpcrr1GMKkRLEWht8,4338
 nova/trame/view/components/__init__.py,sha256=60BeS69aOrFnkptjuD17rfPE1f4Z35iBH56TRmW5MW8,451
-nova/trame/view/components/data_selector.py,sha256=T5CFtWPio3YwiPvPEBrWn7vgRo-3l0GqdGKzonc_cwc,14970
+nova/trame/view/components/data_selector.py,sha256=ByZ1RTyJRfmHNfN-nFi_Ihljo0yjbyfa_El-jHl9oyM,14907
 nova/trame/view/components/execution_buttons.py,sha256=Br6uAmE5bY67TTYc5ZTHECNJ_RJqKmv17HAKPpQtbeg,4576
 nova/trame/view/components/file_upload.py,sha256=WOaFXeNNwN0DYZJr-W6vWdBiTpr7m-lq3WKJaHmeMe8,4560
 nova/trame/view/components/input_field.py,sha256=xzCmNEoB4ljGx99-gGgTV0UwriwtS8ce22zPA4QneZw,17372
 nova/trame/view/components/ornl/__init__.py,sha256=HnxzzSsxw0vQSDCVFfWsAxx1n3HnU37LMuQkfiewmSU,90
-nova/trame/view/components/ornl/neutron_data_selector.py,sha256=6X4sz54DaVYfW8LYOazpA-paGy1mc4gLoka--34GMdE,16762
+nova/trame/view/components/ornl/neutron_data_selector.py,sha256=3IxEYM3wK7RskxbjDG94JeWBCEWXBeF3xBDWt3Bh1OU,16797
 nova/trame/view/components/progress_bar.py,sha256=zhbJwPy_HPQ8YL-ISN8sCRUQ7qY6qqo9wiV59BmvL8I,3038
 nova/trame/view/components/remote_file_input.py,sha256=mcz_bmI2rD8gdmIOKLhlzfj-XoWBwC99T9ZgQORaKqE,14674
 nova/trame/view/components/tool_outputs.py,sha256=IbYV4VjrkWAE354Bh5KH76SPsxGLIkOXChijS4-ce_Y,2408
 nova/trame/view/components/visualization/__init__.py,sha256=reqkkbhD5uSksHHlhVMy1qNUCwSekS5HlXk6wCREYxU,152
 nova/trame/view/components/visualization/interactive_2d_plot.py,sha256=z2s1janxAclpMEdDJk3z-CQ6r3KPNoR_SXPx9ppWnuQ,3481
-nova/trame/view/components/visualization/matplotlib_figure.py,sha256=q0HLaaLFjM3_V1oUk-VBHWvokFY6AQZzmnMcynTroik,12488
+nova/trame/view/components/visualization/matplotlib_figure.py,sha256=8JgbF6elZC8EFZn-c2mLqGSyg0Lb4NLVAKJVSBb9-5g,16010
 nova/trame/view/layouts/__init__.py,sha256=cMrlB5YMUoK8EGB83b34UU0kPTVrH8AxsYvKRtpUNEc,141
-nova/trame/view/layouts/grid.py,sha256=vqEX-jghs6j9_sVtijdRH7uhlD9loWNi90k2qgg4Dhg,5534
-nova/trame/view/layouts/hbox.py,sha256=cdwnGk93ec6dXAeEamRQx1WTj5T7Ygsmsy0xz130tWM,3519
+nova/trame/view/layouts/grid.py,sha256=DU5u5JTE0ulzCaJsEWyTenBH9lOQD7mtoC6RZXxDTPE,6110
+nova/trame/view/layouts/hbox.py,sha256=w6ow7Qzmq4slODz_9f7kEigCVPE2PhUmPODedYH34f4,3850
 nova/trame/view/layouts/utils.py,sha256=Hg34VQWTG3yHBsgNvmfatR4J-uL3cko7UxSJpT-h3JI,376
-nova/trame/view/layouts/vbox.py,sha256=XRV14e32MY1HWc9FTVTv1vOatWWbhLMd0lYwZP-isTg,3520
+nova/trame/view/layouts/vbox.py,sha256=Kkci79zDKF6qNH4HeDPYquJcixXx3BS63NVmS3FlOiw,3851
 nova/trame/view/theme/__init__.py,sha256=70_marDlTigIcPEOGiJb2JTs-8b2sGM5SlY7XBPtBDM,54
-nova/trame/view/theme/assets/core_style.scss,sha256=3-3qMc5gpaDhfuVWAF_psBH5alxwiuK-hPGhVgi2cW0,4335
+nova/trame/view/theme/assets/core_style.scss,sha256=Bf7ajLULXPoJWH2KZk47VsAsMMC7DOYBjG_54l0qsjs,4652
 nova/trame/view/theme/assets/favicon.png,sha256=Xbp1nUmhcBDeObjsebEbEAraPDZ_M163M_ZLtm5AbQc,1927
 nova/trame/view/theme/assets/js/delay_manager.js,sha256=BN4OL88QsyZG4XQ1sTorHpN1rwD4GnWoVKHvl5F5ydo,776
 nova/trame/view/theme/assets/js/lodash.min.js,sha256=KCyAYJ-fsqtp_HMwbjhy6IKjlA5lrVrtWt1JdMsC57k,73016
 nova/trame/view/theme/assets/js/revo_grid.js,sha256=73v-GP4IUIg8OgMnRCoHB6ERFU18nx0VYaEecV_7u-o,5695
 nova/trame/view/theme/assets/vuetify_config.json,sha256=a0FSgpLYWGFlRGSMhMq61MyDFBEBwvz55G4qjkM08cs,5627
 nova/trame/view/theme/exit_button.py,sha256=Kqv1GVJZGrSsj6_JFjGU3vm3iNuMolLC2T1x2IsdmV0,3094
-nova/trame/view/theme/theme.py,sha256=bwKzMkGcqoIx_H70FOYIwG3QYQ6tya0dXJaUoxGWQn0,14575
+nova/trame/view/theme/theme.py,sha256=DMA53DYUS6qpLkqAlfEMOuNlyNgHD13uBMfSeLytGyw,14698
 nova/trame/view/utilities/local_storage.py,sha256=vD8f2VZIpxhIKjZwEaD7siiPCTZO4cw9AfhwdawwYLY,3218
 nova/trame/view_model/data_selector.py,sha256=jAtq5hpohQ6YiLBbgLJfNUzWZBpN2bjCG_c_FCJu2ns,3186
 nova/trame/view_model/execution_buttons.py,sha256=MfKSp95D92EqpD48C15cBo6dLO0Yld4FeRZMJNxJf7Y,3551
@@ -40,8 +40,8 @@ nova/trame/view_model/ornl/neutron_data_selector.py,sha256=PIKQyzcHpwu81DNk3d8Af
 nova/trame/view_model/progress_bar.py,sha256=6AUKHF3hfzbdsHqNEnmHRgDcBKY5TT8ywDx9S6ovnsc,2854
 nova/trame/view_model/remote_file_input.py,sha256=zWOflmCDJYYR_pacHphwzricV667GSRokh-mlxpBAOo,3646
 nova/trame/view_model/tool_outputs.py,sha256=ev6LY7fJ0H2xAJn9f5ww28c8Kpom2SYc2FbvFcoN4zg,829
-nova_trame-0.27.0.dist-info/METADATA,sha256=pj-cjaC_mkFmqwPXwbOyDi0R8UdhikVQKD4jf_H0Kjc,1796
-nova_trame-0.27.0.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
-nova_trame-0.27.0.dist-info/entry_points.txt,sha256=J2AmeSwiTYZ4ZqHHp9HO6v4MaYQTTBPbNh6WtoqOT58,42
-nova_trame-0.27.0.dist-info/licenses/LICENSE,sha256=Iu5QiDbwNbREg75iYaxIJ_V-zppuv4QFuBhAW-qiAlM,1061
-nova_trame-0.27.0.dist-info/RECORD,,
+nova_trame-1.0.0.dist-info/METADATA,sha256=nqvFzLDJCyIuPqZmNK9rIXR6x0nfjIRt0cmU17zDFXI,2096
+nova_trame-1.0.0.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+nova_trame-1.0.0.dist-info/entry_points.txt,sha256=J2AmeSwiTYZ4ZqHHp9HO6v4MaYQTTBPbNh6WtoqOT58,42
+nova_trame-1.0.0.dist-info/licenses/LICENSE,sha256=Iu5QiDbwNbREg75iYaxIJ_V-zppuv4QFuBhAW-qiAlM,1061
+nova_trame-1.0.0.dist-info/RECORD,,