Merge branch 'refactor_utils' into 'main'

Refactor utils

See merge request cschmidt/4c-webviewer!3

Author: gilrrei

src/fourc_webviewer/cli_utils.py

@@ -1,14 +1,22 @@
+"""CLI utils module."""
+
 import argparse
 
 import fourc_webviewer.run_webserver as webserver
 
 
 def main():
+    """Get the CLI arguments and start the webviewer."""
     arguments = get_arguments()
     webserver.run_webviewer(**arguments)
 
 
 def get_arguments():
+    """Get the CLI arguments.
+
+    Returns:
+        dict: Arguments dictionary
+    """
     parser = argparse.ArgumentParser(description="4C Webviewer")
     parser.add_argument("--dat_file", type=str, help="input file path to visualize")
 

src/fourc_webviewer/input_file_utils/dat_file_visualization.py

@@ -1,3 +1,5 @@
+"""Dat file visualization."""
+
 import lnmmeshio
 import numpy as np
 import os
@@ -12,12 +14,15 @@
 
 
 def convert_to_vtu(dat_file_path, temp_dir):
-    # This function converts a given dat file into a corresponding vtu file
-    #   Input:
-    #       dat_file_path: string: full path to the dat file to be converted
-    #   Output:
-    #       vtu_file_path: full path of the converted file
+    """Convert dat file to vtu.
+
+    Args:
+        dat_file_path (str, Path): Path to dat file
+        temp_dir (str, Path): Temp directory
 
+    Returns:
+        str: Path to vtu file
+    """
     # define the vtu_file_path to have the same name as the dat file, but the its directory is in './temp_files'
     vtu_file_path = str(
         Path(temp_dir) / f"{os.path.splitext(os.path.basename(dat_file_path))[0]}.vtu"
@@ -36,6 +41,14 @@ def convert_to_vtu(dat_file_path, temp_dir):
 
 
 def function_plot_figure(state_data):
+    """Get function plot figure.
+
+    Args:
+        state_data (trame_server.core.Server): Trame server state
+
+    Returns:
+        plotly.graph_objects._figure.Figure: Figure to be plotted
+    """
     num_of_time_points = 1000  # number of discrete time points used for plotting
     data = {
         "t": np.linspace(0, state_data.MAX_TIME, num_of_time_points),
@@ -66,11 +79,14 @@ def function_plot_figure(state_data):
 
 
 def return_function_from_funct_string(funct_string):
-    # The function takes in the value of the funct string coming from a function and returns the parsed function
-    #   Input:
-    #       funct_string: string of the function, containing the variables t, x, y, z
-    #   Output:
-    #       return_funct: function of the mentioned arguments
+    """Create function from funct string.
+
+    Args:
+        funct_string (str): Funct definition
+
+    Returns:
+        callable: callable function of x, y, z, t
+    """
 
     def funct_using_eval(x, y, z, t):
         # defined functions to be replaced: <def_funct> becomes <np.funct>
@@ -101,7 +117,14 @@ def funct_using_eval(x, y, z, t):
     return np.frompyfunc(funct_using_eval, 4, 1)
 
 
-def to_vtu(dis, vtu_file: str, override=True, ascii=False):
+def to_vtu(dis, vtu_file: str, override=True):
+    """Discretization to vtu.
+
+    Args:
+        dis (lnmmeshio.Discretization): Discretization object
+        vtu_file (str): Path to vtu file
+        override (bool, optional): Overwrite existing file. Defaults to True
+    """
     add_dat_file_data_to_dis(dis)
 
     # write case file
@@ -111,12 +134,3 @@ def to_vtu(dis, vtu_file: str, override=True, ascii=False):
         file_format="vtu",
         override=override,
     )
-
-
-def validate_vtu_file_path(vtu_file_path):
-    # Validate the file path: file has to exist and end with ".vtu"
-    if not vtu_file_path.endswith(".dat"):
-        raise Exception("Provided file does not end with .dat!")
-
-    if not os.path.exists(vtu_file_path):
-        raise Exception("Provided file does not exist!")

src/fourc_webviewer/input_file_utils/read_dat_file.py

@@ -1,7 +1,5 @@
-# ------------------------------------------------------------------------------#
-#                     READ AND SECTION A PROVIDED DAT FILE                     #
-# ------------------------------------------------------------------------------#
-import os
+"""Dat file reader utils."""
+
 import re
 
 from fourc_webviewer.python_utils import list_is_iterable

src/fourc_webviewer/input_file_utils/write_dat_file.py

@@ -1,6 +1,4 @@
-# ------------------------------------------------------------------------------#
-#                       WRITE A DAT FILE FROM INPUT INFO                       #
-# ------------------------------------------------------------------------------#
+"""Dat file writer utils."""
 
 import math
 import re
@@ -214,8 +212,3 @@ def flatten_input_list(lst):
         else:
             flattened_list.append(item)
     return flattened_list
-
-
-if __name__ == "__main__":
-    ...
-    # no need to implement anything here, as the method can only be called from within the main.py

src/fourc_webviewer/python_utils.py

@@ -1,7 +1,17 @@
+""" Module for python utils."""
+
+
 def list_is_iterable(obj):
+    """Check if object is iterable.
+
+    Args:
+        obj (obj): Object to be checked
+
+    Returns:
+        bool: True if object is iterable
+    """
     try:
         iter(obj)
-    except Exception:
+    except TypeError:
         return False
-    else:
-        return True
+    return True

test/test_pyvista.py

@@ -0,0 +1,62 @@
+import tempfile
+from pathlib import Path
+
+import pyvista as pv
+from pyvista.trame.ui import plotter_ui
+from trame.app import get_server
+from trame.app.file_upload import ClientFile
+from trame.ui.vuetify3 import SinglePageLayout
+from trame.widgets import vuetify3
+
+pv.OFF_SCREEN = True
+
+server = get_server()
+state, ctrl = server.state, server.controller
+
+pl = pv.Plotter()
+
+
+@server.state.change("file_exchange")
+def handle(file_exchange, **kwargs) -> None:
+    if file_exchange:
+
+        file = ClientFile(file_exchange[0])
+        if file.content:
+            pl.remove_actor("mesh")
+            bytes = file.content  # noqa: A001
+            with tempfile.NamedTemporaryFile(suffix=file.name) as path:
+                with Path(path.name).open("wb") as f:
+                    f.write(bytes)
+                ds = pv.read(path.name).extract_surface()
+            pl.add_mesh(ds, name="mesh")
+            pl.reset_camera()
+    else:
+        pl.clear_actors()
+        pl.reset_camera()
+
+
+with SinglePageLayout(server) as layout:
+    with layout.toolbar:
+        vuetify3.VSpacer()
+        vuetify3.VFileInput(
+            multiple=False,
+            show_size=True,
+            small_chips=True,
+            truncate_length=25,
+            v_model=("file_exchange", None),
+            density="compact",
+            hide_details=True,
+            style="max-width: 300px;",
+        )
+        vuetify3.VProgressLinear(
+            indeterminate=True, absolute=True, bottom=True, active=("trame__busy",)
+        )
+
+        with layout.content:  # noqa: SIM117
+            with vuetify3.VContainer(
+                fluid=True, classes="pa-0 fill-height", style="position: relative;"
+            ):
+                view = plotter_ui(pl)
+                ctrl.view_update = view.update
+# Show UI
+server.start()