Add further docstring for interrogate checks

Author: dragos-ana

src/fourc_webviewer/__init__.py

@@ -0,0 +1 @@
+"""Module to initialize and run the webviewer application."""

src/fourc_webviewer/fourc_webserver.py

@@ -1,3 +1,7 @@
+"""This module defines the FourCWebServer class, which manages the application
+state, synchronizes server variables, and handles PyVista rendering for the 4C
+web viewer."""
+
 import copy
 import re
 import tempfile
@@ -109,11 +113,14 @@ def __init__(self, page_title, fourc_yaml_file):
 
     @property
     def state(self):
+        """Get state."""
+
         # self.state contains all the state variables to be shared between server and client
         return self.server.state
 
     @property
     def ctrl(self):
+        """Get controller."""
         # self.ctrl contains all the control functions callable on both the Javascript client-side and the Python server (running on the Python server)
         return self.server.controller
 
@@ -773,6 +780,8 @@ def sync_funct_section_from_state(self):
                 )
 
     def init_mode_state_vars(self):
+        """Initialize state variables related to mode changes (edit mode, view
+        mode) and statuses (e.g. read-in status)."""
         # initialize the read-in status and its possible choices
         self.state.all_read_in_statuses = {
             "success": "SUCCESS",  # successful read-in of the file
@@ -821,6 +830,8 @@ def init_mode_state_vars(self):
     ################################################
     @change("fourc_yaml_file")
     def change_fourc_yaml_file(self, fourc_yaml_file, **kwargs):
+        """Reaction to change of state.fourc_yaml_file."""
+
         # create temporary fourc yaml file from the content of the given file
         temp_fourc_yaml_file = Path(
             self._server_vars["temp_dir_object"].name, fourc_yaml_file["name"]
@@ -848,6 +859,7 @@ def change_fourc_yaml_file(self, fourc_yaml_file, **kwargs):
 
     @change("export_fourc_yaml_path")
     def change_export_fourc_yaml_path(self, export_fourc_yaml_path, **kwargs):
+        """Reaction to change of state.export_fourc_yaml_path."""
         # set the export status to info
         self.state.export_status = self.state.all_export_statuses["info"]
 
@@ -856,6 +868,7 @@ def change_export_fourc_yaml_path(self, export_fourc_yaml_path, **kwargs):
     ################################################
     @change("selected_main_section_name")
     def change_selected_main_section_name(self, selected_main_section_name, **kwargs):
+        """Reaction to change of state.selected_main_section_name."""
         # set selected section name to the first one within the selected
         # main section
         self.state.selected_section_name = self.state.section_names[
@@ -864,6 +877,7 @@ def change_selected_main_section_name(self, selected_main_section_name, **kwargs
 
     @change("selected_material")
     def change_selected_material(self, selected_material, **kwargs):
+        """Reaction to change of state.selected_material."""
         # we need to select the material region based on the newly selected
         # material (if we are not in an initial rendering scenario)
         if self._server_vars["render_count"]["change_selected_material"] > 0:
@@ -888,6 +902,7 @@ def change_selected_material(self, selected_material, **kwargs):
 
     @change("selected_dc_geometry_type")
     def change_selected_dc_geometry_type(self, selected_dc_geometry_type, **kwargs):
+        """Reaction to change of state.selected_dc_geometry_type."""
         # change entity to the first of the selected geometry
         self.state.selected_dc_entity = next(
             iter(self.state.dc_sections[selected_dc_geometry_type])
@@ -910,6 +925,7 @@ def change_selected_dc_geometry_type(self, selected_dc_geometry_type, **kwargs):
 
     @change("selected_dc_entity")
     def change_selected_dc_entity(self, selected_dc_entity, **kwargs):
+        """Reaction to change of state.selected_dc_entity."""
         # change selected condition for the geometry-entity combination
         self.state.selected_dc_condition = next(
             iter(
@@ -929,6 +945,7 @@ def change_selected_dc_entity(self, selected_dc_entity, **kwargs):
     def change_selected_result_description_id(
         self, selected_result_description_id, **kwargs
     ):
+        """Reaction to change of state.selected_result_description_id."""
         # update plotter / render objects
         self.update_pyvista_render_objects()
 
@@ -937,6 +954,7 @@ def change_selected_result_description_id(
 
     @change("selected_funct")
     def change_selected_funct(self, selected_funct, **kwargs):
+        """Reaction to change of state.selected_funct."""
         # set the selected funct item to the first within the newly
         # selected funct
         self.state.selected_funct_item = next(
@@ -951,6 +969,7 @@ def change_selected_funct(self, selected_funct, **kwargs):
 
     @change("selected_funct_item")
     def change_selected_funct_item(self, selected_funct_item, **kwargs):
+        """Reaction to change of state.selected_funct_item."""
         # update plotly figure
         if self.state.funct_section[self.state.selected_funct][
             self.state.selected_funct_item
@@ -962,6 +981,7 @@ def change_selected_funct_item(self, selected_funct_item, **kwargs):
     ################################################
     @change("funct_plot")
     def change_funct_plot(self, funct_plot, **kwargs):
+        """Reaction to change of state.funct_plot."""
         # update plotly figure
         if self.state.funct_section[self.state.selected_funct][
             self.state.selected_funct_item
@@ -970,6 +990,7 @@ def change_funct_plot(self, funct_plot, **kwargs):
 
     @change("funct_section")
     def change_funct_section(self, funct_section, **kwargs):
+        """Reaction to change of state.funct_section."""
         # update plotly figure
         if self.state.funct_section[self.state.selected_funct][
             self.state.selected_funct_item
@@ -980,7 +1001,8 @@ def change_funct_section(self, funct_section, **kwargs):
     # MODE CHANGES #################################
     ################################################
     @change("edit_mode")
-    def on_edit_mode_changed(self, edit_mode, **kwargs):
+    def change_edit_mode(self, edit_mode, **kwargs):
+        """Reaction to change of state.edit_mode."""
         # cast entered string values from VTextField (edit mode) to
         # numbers
         if (
@@ -1004,7 +1026,8 @@ def on_edit_mode_changed(self, edit_mode, **kwargs):
             # self.state.funct_section = convert_string2number(self.state.funct_section)
 
     @change("export_mode")
-    def on_export_mode_changed(self, export_mode, **kwargs):
+    def change_export_mode(self, export_mode, **kwargs):
+        """Reaction to change of state.export_mode."""
         # revert export status to "INFO"
         self.state.export_status = self.state.all_export_statuses["info"]
 
@@ -1126,4 +1149,5 @@ def determine_master_mat_ind_for_current_selection(self):
         return master_mat_id
 
     def cleanup(self):
+        """Perform cleanup tasks for the webserver."""
         self._server_vars["temp_dir_object"].cleanup()

src/fourc_webviewer/gui_utils.py

@@ -1,3 +1,5 @@
+"""Specifies the GUI layout."""
+
 import plotly
 from pyvista.trame.ui import plotter_ui
 
@@ -22,6 +24,7 @@ class VFileInput(HtmlElement):
     currently support all relevant attributes, such as e.g. 'accept'."""
 
     def __init__(self, children=None, **kwargs):
+        """Initialize custom VFileInput element."""
         super().__init__("v-file-input", children, **kwargs)
         self._attr_names += [
             "accept",
@@ -101,6 +104,7 @@ def __init__(self, children=None, **kwargs):
 
 
 def _toolbar(server_controller):
+    """Toolbar layout."""
     VFileInput(
         label="Input file",
         v_model=("fourc_yaml_file",),
@@ -131,6 +135,7 @@ def _toolbar(server_controller):
 
 
 def _bottom_sheet_info():
+    """Bottom sheet layout (INFO mode)."""
     with vuetify.VBottomSheet(v_model=("info_mode",), inset=True):
         with vuetify.VCard(
             classes="text-center",
@@ -169,6 +174,7 @@ def _bottom_sheet_info():
 
 
 def _bottom_sheet_export(server_controller):
+    """Bottom sheet layout (EXPORT mode)."""
     with vuetify.VBottomSheet(v_model=("export_mode",), inset=True):
         with vuetify.VCard(classes="text-center", height=250, title="Export"):
             with vuetify.VCardText():
@@ -202,6 +208,7 @@ def _bottom_sheet_export(server_controller):
 
 
 def _sections_dropdown():
+    """Section dropdown layout."""
     vuetify.VSelect(
         v_model=("selected_main_section_name",),
         items=("Object.keys(section_names)",),
@@ -214,6 +221,7 @@ def _sections_dropdown():
 
 
 def _functions_panel(server):
+    """Functions panel layout."""
     with html.Div(
         v_if=(
             "section_names[selected_main_section_name]['content_mode'] == all_content_modes['funct_section']"
@@ -395,6 +403,7 @@ def _functions_panel(server):
 
 
 def _prop_value_table():
+    """Table (property - value) layout (for general sections)."""
     with vuetify.VTable(
         v_if=(
             "section_names[selected_main_section_name]['content_mode'] == all_content_modes['general_section']",
@@ -443,6 +452,7 @@ def _prop_value_table():
 
 
 def _materials_panel():
+    """Materials panel layout."""
     with html.Div(
         v_if=(
             "section_names[selected_main_section_name]['content_mode'] == all_content_modes['materials_section']"
@@ -696,6 +706,7 @@ def _materials_panel():
 
 
 def _design_conditions_panel():
+    """Layout for the design conditions panel."""
     with html.Div(
         v_if=(
             "section_names[selected_main_section_name]['content_mode'] == all_content_modes['design_conditions_section']"
@@ -831,6 +842,7 @@ def _design_conditions_panel():
 
 
 def _result_description_panel():
+    """Layout for the result description panel."""
     with html.Div(
         v_if=(
             "section_names[selected_main_section_name]['content_mode'] == all_content_modes['result_description_section']",
@@ -1007,6 +1019,8 @@ def _result_description_panel():
 
 
 def create_gui(server, render_window):
+    """Creates the graphical user interface based on the defined layout
+    elements."""
     with SinglePageWithDrawerLayout(server) as layout:
         layout.title.set_text("4C Webviewer")
 

src/fourc_webviewer/input_file_utils/__init__.py

@@ -0,0 +1 @@
+"""Module for handling and managing input files."""

src/fourc_webviewer/input_file_utils/fourc_yaml_file_visualization.py

@@ -131,6 +131,18 @@ def return_function_from_funct_string(funct_string):
     """
 
     def funct_using_eval(x, y, z, t):
+        """Evaluate function expression for given positional x, y, z
+        coordinates and time t values.
+
+        Args:
+            x (double): x-coordinate
+            y (double): y-coordinate
+            z (double): z-coordinate
+            t (double): time t
+
+        Returns:
+            parsed object using ast.literal_eval
+        """
         # defined functions to be replaced: <def_funct> becomes <np.funct>
         def_funct = ["exp", "sqrt", "log", "sin", "cos", "tan", "heaviside"]
 

src/fourc_webviewer/input_file_utils/io_utils.py

@@ -92,6 +92,8 @@ def write_fourc_yaml_file(fourc_yaml_content, new_fourc_yaml_file):
 
 
 def add_fourc_yaml_file_data_to_dis(dis):
+    """Adds further data contained within the yaml file (e.g. material id) to
+    the discretization from lnmmeshio."""
     dis.compute_ids(zero_based=False)
 
     # write node data

src/fourc_webviewer/main.py

@@ -1,3 +1,5 @@
+"""Main entry point for launching the webviewer."""
+
 from fourc_webviewer.cli_utils import main
 
 if __name__ == "__main__":

src/fourc_webviewer/run_webserver.py

@@ -1,8 +1,5 @@
-# ------------------------------------------------------------------------------#
-#                               IMPORT SECTION                                 #
-# ------------------------------------------------------------------------------#
+"""Utility to run the webserver on a defined port."""
 
-from fourc_webviewer.fourc_webserver import FourCWebServer
 from fourc_webviewer_default_files import (
     DEFAULT_INPUT_FILE,
 )
@@ -12,6 +9,9 @@
 
 
 def run_webviewer(fourc_yaml_file=None):
+    """Runs the webviewer by creating a dedicated webserver object, starting it
+    and cleaning up afterwards."""
+
     if fourc_yaml_file is None:
         fourc_yaml_file = str(DEFAULT_INPUT_FILE)
 

test/test_pyvista.py

@@ -1,3 +1,5 @@
+"""Tests related to pyvista plotting."""
+
 import tempfile
 from pathlib import Path
 
@@ -18,6 +20,7 @@
 
 @server.state.change("file_exchange")
 def handle(file_exchange, **kwargs) -> None:
+    """Reaction to file exchange."""
     if file_exchange:
         file = ClientFile(file_exchange[0])
         if file.content: