Adding Settings Menu

protzilla/steps.py

@@ -11,7 +11,7 @@
 import pandas as pd
 import plotly.io as pio
 import plotly.graph_objects as go
-from PIL import Image, features
+from PIL import Image
 
 from protzilla.utilities import format_trace
 
@@ -281,6 +281,7 @@ def empty(self) -> bool:
     def export(self, settings: dict) -> list:
         """
         Converts all plots from this step to files according to the format and size in the Plotly template.
+        An exported plot is represented as BytesIO object containing binary image data.
         :param settings: Dict containing the plot settings.
         :return: List of all exported plots.
         """

protzilla/utilities/utilities.py

@@ -11,6 +11,7 @@
 import pandas as pd
 import psutil
 
+from django.http import QueryDict
 
 # recipie from https://docs.python.org/3/library/itertools.html
 def unique_justseen(iterable, key=None):
@@ -138,7 +139,12 @@ def get_file_name_from_upload_path(upload_path: str) -> str:
     return f"{base_name}.{file_extension}"
 
 
-def parameters_from_post(post):
+def parameters_from_post(post: QueryDict) -> dict:
+    """
+    Removes token from dict and converts the remaining entries into suitable data formats.
+    :param post: Django dict containing POST data.
+    :return: Dict containing the parameters in suitable formats.
+    """
     d = dict(post)
     if "csrfmiddlewaretoken" in d:
         del d["csrfmiddlewaretoken"]
@@ -153,6 +159,11 @@ def parameters_from_post(post):
 
 
 def convert_str_if_possible(s):
+    """
+    Converts an input value into suitable representation as a string.
+    :param s: Input value.
+    :return: Converted input value.
+    """
     try:
         f = float(s)
         return int(f) if int(f) == f else f

tests/ui/test_settings.py

@@ -0,0 +1,41 @@
+import pytest
+import plotly.graph_objects as go
+
+from protzilla.constants.colors import PLOT_PRIMARY_COLOR, PLOT_SECONDARY_COLOR
+from protzilla.constants.paths import SETTINGS_PATH
+from ui.settings.plot_template import (
+    determine_font,
+    resize_for_display,
+    get_scale_factor
+)
+
+
+@pytest.fixture
+def sample_params():
+    return {
+        "section_id": "plots",
+        "file_format": "png",
+        "width": 85,
+        "height": 60,
+        "custom_font": "Ubuntu Mono",
+        "font": "Arial",
+        "heading_size": 11,
+        "text_size": 8
+    }
+
+def test_determine_font(sample_params):
+    assert determine_font(sample_params) == "Arial"
+    sample_params["font"] = "Custom"
+    assert determine_font(sample_params) == "Ubuntu Mono"
+
+def test_resize_for_display(sample_params):
+    result = resize_for_display(sample_params)
+    assert result["display_width"] == 600  # SCALED_WIDTH
+    assert result["display_heading_size"] == 26
+
+def test_get_scale_factor(sample_params):
+    fig = go.Figure()
+    fig.update_layout(width=600)
+    scale = get_scale_factor(fig, sample_params)
+    assert isinstance(scale, float)
+    assert round(scale, 3) == 1.735

ui/settings/plot_template.py

@@ -6,7 +6,9 @@
 from protzilla.constants.colors import PLOT_PRIMARY_COLOR, PLOT_SECONDARY_COLOR
 from protzilla.constants.paths import SETTINGS_PATH
 
+
 SCALED_WIDTH = 600
+template = None
 
 def load_settings(section_id: str) -> dict:
     """
@@ -33,7 +35,7 @@ def save_settings(params: dict, section_id: str):
     op = YamlOperator()
     path = SETTINGS_PATH / (section_id + ".yaml")
     op.write(path, params)
-    if section_id == "plots" and template:
+    if section_id == "plots" and isinstance(template, PlotTemplate):
         template.update(params)
         template.apply()
 

ui/settings/templates/settings_databases.html

@@ -27,7 +27,10 @@ <h3>Manage Databases</h3>
                 <form method="post" id="settings-form">
                     {% csrf_token %}
                     <input type="hidden" name="section_id" value="{{ section_id }}">
-                    <!-- TO DO: Move database content to this page -->
+
+                    <!-- PLEASE NOTE: This HTML is a placeholder. TO DO: Move "Manage databases" content to this page. -->
+                    <p><b>Please note: This page is an placeholder for displaying the database management in the future.</b></p>
+
                     <div class="mb-2" id="settings-form">
                         <h5>Datebases</h5>
                         <div class="field-wrapper">

user_data/settings/plots_default.yaml

@@ -1,8 +1,8 @@
 custom_font: ''
 file_format: png
 font: Arial
-heading_size: 22
-height: 40
+heading_size: 11
+height: 60
 section_id: plots
-text_size: 16
-width: 60
+text_size: 8
+width: 85