nova-trame 0.17.3__py3-none-any.whl → 0.18.0__py3-none-any.whl

nova/trame/view/components/__init__.py

@@ -1,4 +1,5 @@
+from .file_upload import FileUpload
 from .input_field import InputField
 from .remote_file_input import RemoteFileInput
 
-__all__ = ["InputField", "RemoteFileInput"]
+__all__ = ["FileUpload", "InputField", "RemoteFileInput"]

nova/trame/view/components/file_upload.py

@@ -0,0 +1,82 @@
+"""View implementation for FileUpload."""
+
+from typing import Any, List, Optional
+
+from trame.widgets import vuetify3 as vuetify
+
+from .remote_file_input import RemoteFileInput
+
+
+class FileUpload(vuetify.VBtn):
+    """Component for uploading a file from either the user's filesystem or the server filesystem."""
+
+    def __init__(self, v_model: str, base_paths: Optional[List[str]] = None, label: str = "", **kwargs: Any) -> None:
+        """Constructor for FileUpload.
+
+        Parameters
+        ----------
+        v_model : str
+            The state variable to set when the user uploads their file. The state variable will contain a latin1-decoded
+            version of the file contents. If your file is binary or requires a different string encoding, then you can
+            call `encode('latin1')` on the file contents to get the underlying bytes.
+        base_paths: list[str], optional
+            Passed to :ref:`RemoteFileInput <api_remotefileinput>`.
+        label : str, optional
+            The text to display on the upload button.
+        **kwargs
+            All other arguments will be passed to the underlying
+            `Button component <https://trame.readthedocs.io/en/latest/trame.widgets.vuetify3.html#trame.widgets.vuetify3.VBtn>`_.
+
+        Returns
+        -------
+        None
+        """
+        self._v_model = v_model
+        if base_paths:
+            self._base_paths = base_paths
+        else:
+            self._base_paths = ["/"]
+        self._ref_name = f"nova__fileupload_{self._next_id}"
+
+        super().__init__(label, **kwargs)
+        self.create_ui()
+
+    def create_ui(self) -> None:
+        self.local_file_input = vuetify.VFileInput(
+            v_model=(self._v_model, None),
+            classes="d-none",
+            ref=self._ref_name,
+            # Serialize the content in a way that will work with nova-mvvm and then push it to the server.
+            update_modelValue=(
+                f"{self._v_model}.arrayBuffer().then((contents) => {{"
+                f"trigger('decode_blob_{self._id}', [contents]); "
+                "});"
+            ),
+        )
+        self.remote_file_input = RemoteFileInput(
+            v_model=self._v_model, base_paths=self._base_paths, input_props={"classes": "d-none"}, return_contents=True
+        )
+
+        with self:
+            with vuetify.VMenu(activator="parent"):
+                with vuetify.VList():
+                    vuetify.VListItem("From Local Machine", click=f"trame.refs.{self._ref_name}.click()")
+                    vuetify.VListItem("From Analysis Cluster", click=self.remote_file_input.open_dialog)
+
+        @self.server.controller.trigger(f"decode_blob_{self._id}")
+        def _decode_blob(contents: bytes) -> None:
+            self.remote_file_input.decode_file(contents)
+
+    def select_file(self, value: str) -> None:
+        """Programmatically set the RemoteFileInput path.
+
+        Parameters
+        ----------
+        value: str
+            The new value for the RemoteFileInput.
+
+        Returns
+        -------
+        None
+        """
+        self.remote_file_input.select_file(value)

nova/trame/view/components/remote_file_input.py

@@ -10,9 +10,10 @@ from trame_client.widgets.core import AbstractElement
 
 from nova.mvvm.trame_binding import TrameBinding
 from nova.trame.model.remote_file_input import RemoteFileInputModel
-from nova.trame.view.components import InputField
 from nova.trame.view_model.remote_file_input import RemoteFileInputViewModel
 
+from .input_field import InputField
+
 
 class RemoteFileInput:
     """Generates a file selection dialog for picking files off of the server.
@@ -30,6 +31,7 @@ class RemoteFileInput:
         dialog_props: Optional[dict[str, Any]] = None,
         extensions: Optional[list[str]] = None,
         input_props: Optional[dict[str, Any]] = None,
+        return_contents: bool = False,
     ) -> None:
         """Constructor for RemoteFileInput.
 
@@ -52,6 +54,9 @@ class RemoteFileInput:
             Only files with these extensions will be shown by default. The user can still choose to view all files.
         input_props : dict[str, typing.Any], optional
             Props to be passed to InputField.
+        return_contents : bool
+            If true, then the v_model will contain the contents of the file. If false, then the v_model will contain the
+            path of the file.
 
         Raises
         ------
@@ -73,6 +78,7 @@ class RemoteFileInput:
         self.dialog_props = dict(dialog_props) if dialog_props else {}
         self.extensions = extensions if extensions else []
         self.input_props = dict(input_props) if input_props else {}
+        self.return_contents = return_contents
 
         if "__events" not in self.input_props:
             self.input_props["__events"] = []
@@ -178,14 +184,35 @@ class RemoteFileInput:
         else:
             model_name = self.v_model
 
+        self.set_v_model = client.JSEval(
+            exec=f"{model_name} = $event; flushState('{model_name.split('.')[0].split('[')[0]}');"
+        ).exec
+
         self.vm = RemoteFileInputViewModel(self.model, binding)
 
         self.vm.dialog_bind.connect(self.vm.get_dialog_state_name())
         self.vm.file_list_bind.connect(self.vm.get_file_list_state_name())
         self.vm.filter_bind.connect(self.vm.get_filter_state_name())
         self.vm.on_close_bind.connect(client.JSEval(exec=f"{self.vm.get_dialog_state_name()} = false;").exec)
-        self.vm.on_update_bind.connect(
-            client.JSEval(exec=f"{model_name} = $event; flushState('{model_name.split('.')[0].split('[')[0]}');").exec
-        )
+        if self.return_contents:
+            self.vm.on_update_bind.connect(self.read_file)
+        else:
+            self.vm.on_update_bind.connect(self.set_v_model)
         self.vm.showing_all_bind.connect(self.vm.get_showing_all_state_name())
         self.vm.valid_selection_bind.connect(self.vm.get_valid_selection_state_name())
+
+    def read_file(self, file_path: str) -> None:
+        with open(file_path, mode="rb") as file:
+            self.decode_file(file.read())
+
+    def decode_file(self, bytestream: bytes) -> None:
+        decoded_content = bytestream.decode("latin1")
+        self.set_v_model(decoded_content)
+
+    def select_file(self, value: str) -> None:
+        """Programmatically set the v_model value."""
+        self.vm.select_file(value)
+
+    def open_dialog(self) -> None:
+        """Programmatically opens the dialog for selecting a file."""
+        self.vm.open_dialog()

nova/trame/view/theme/theme.py

@@ -233,7 +233,7 @@ class ThemedApp:
                         # [slot override example]
                         layout.pre_content = vuetify.VSheet(classes="bg-background ")
                         # [slot override example complete]
-                        with vuetify.VContainer(classes="flex-1-1 overflow-hidden pt-0 pb-0", fluid=True):
+                        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 ")
 

nova/trame/view_model/remote_file_input.py

@@ -35,6 +35,8 @@ class RemoteFileInputViewModel:
         self.previous_value = self.value
         self.populate_file_list()
 
+        self.dialog_bind.update_in_view(True)
+
     def close_dialog(self, cancel: bool = False) -> None:
         if not cancel:
             self.on_update_bind.update_in_view(self.value)

{nova_trame-0.17.3.dist-info → nova_trame-0.18.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: nova-trame
-Version: 0.17.3
+Version: 0.18.0
 Summary: A Python Package for injecting curated themes and custom components into Trame applications
 License: MIT
 Keywords: NDIP,Python,Trame,Vuetify
@@ -25,6 +25,7 @@ Requires-Dist: trame-matplotlib
 Requires-Dist: trame-plotly
 Requires-Dist: trame-vega
 Requires-Dist: trame-vuetify
+Project-URL: Changelog, https://code.ornl.gov/ndip/public-packages/nova-trame/blob/main/CHANGELOG.md
 Description-Content-Type: text/markdown
 
 nova-trame

{nova_trame-0.17.3.dist-info → nova_trame-0.18.0.dist-info}/RECORD

@@ -1,9 +1,10 @@
 nova/__init__.py,sha256=ED6jHcYiuYpr_0vjGz0zx2lrrmJT9sDJCzIljoDfmlM,65
 nova/trame/__init__.py,sha256=gFrAg1qva5PIqR5TjvPzAxLx103IKipJLqp3XXvrQL8,59
 nova/trame/model/remote_file_input.py,sha256=9KAf31ZHzpsh_aXUrNcF81Q5jvUZDWCzW1QATKls-Jk,3675
-nova/trame/view/components/__init__.py,sha256=fopr6mVqcpDcVYK9ue7SLUHyswgvRPcFESTq86mu1R8,128
+nova/trame/view/components/__init__.py,sha256=pzMkVyeHL9DjL8w5jN5n2FJbigo1lYIqgUSgjoQz5UA,178
+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/remote_file_input.py,sha256=k2yrwkell_g0sGnWR9XLL1LxkmFLr8-AGhduo8E-N4A,8669
+nova/trame/view/components/remote_file_input.py,sha256=MnsUttZaCy8vEpOmRqXMsWa6PiC-RTRb-hJnnH0rBZc,9644
 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=xxgEAE2boc-sIFEIsbJxQZQ5biBMBXT0U8Il5299VNc,11974
@@ -18,11 +19,11 @@ nova/trame/view/theme/assets/js/delay_manager.js,sha256=vmb34DZ5YCQIlRW9Tf2M_uvJ
 nova/trame/view/theme/assets/js/lodash.debounce.min.js,sha256=GLzlQH04WDUNYN7i39ttHHejSdu-CpAvfWgDgKDn-OY,4448
 nova/trame/view/theme/assets/js/lodash.throttle.min.js,sha256=9csqjX-M-LVGJnF3z4ha1R_36O5AfkFE8rPHkxmt3tE,4677
 nova/trame/view/theme/assets/vuetify_config.json,sha256=JBWBfDvxBAWTw3zi0loorFvwwTksTUjQTWR4zYSQPSY,5095
-nova/trame/view/theme/theme.py,sha256=yBaHOvugzxh9vsBOGlOpp2IVMuLj922P6MSXoSz7tk0,11820
+nova/trame/view/theme/theme.py,sha256=OFUtq1IWriFcDu-346J67ZrSES8IOI9PTY_4Vwg7bZQ,11820
 nova/trame/view/utilities/local_storage.py,sha256=vD8f2VZIpxhIKjZwEaD7siiPCTZO4cw9AfhwdawwYLY,3218
-nova/trame/view_model/remote_file_input.py,sha256=WHWCQkZBGeKLe1aTPbtVNI8tn-PDt64mi1-561uuBpQ,3320
-nova_trame-0.17.3.dist-info/LICENSE,sha256=Iu5QiDbwNbREg75iYaxIJ_V-zppuv4QFuBhAW-qiAlM,1061
-nova_trame-0.17.3.dist-info/METADATA,sha256=PcFti25euMmdCYTN4r2q1kdxUiXDbC7DLlOiu1SapHY,1345
-nova_trame-0.17.3.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
-nova_trame-0.17.3.dist-info/entry_points.txt,sha256=J2AmeSwiTYZ4ZqHHp9HO6v4MaYQTTBPbNh6WtoqOT58,42
-nova_trame-0.17.3.dist-info/RECORD,,
+nova/trame/view_model/remote_file_input.py,sha256=ojEOJ8ZPkajpbAaZi9VLj7g-uBjhb8BMrTdMmwf_J6A,3367
+nova_trame-0.18.0.dist-info/LICENSE,sha256=Iu5QiDbwNbREg75iYaxIJ_V-zppuv4QFuBhAW-qiAlM,1061
+nova_trame-0.18.0.dist-info/METADATA,sha256=KaHiL5ELy26kn_xo1myVKyBLURbNBfUH4Pjwpn8YAUo,1446
+nova_trame-0.18.0.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
+nova_trame-0.18.0.dist-info/entry_points.txt,sha256=J2AmeSwiTYZ4ZqHHp9HO6v4MaYQTTBPbNh6WtoqOT58,42
+nova_trame-0.18.0.dist-info/RECORD,,