frequenz-cs-reporting 0.4.2__tar.gz → 0.4.4__tar.gz

{frequenz_cs_reporting-0.4.2 → frequenz_cs_reporting-0.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: frequenz-cs-reporting
-Version: 0.4.2
+Version: 0.4.4
 Summary: Streamlit Library for reporting and solar monitoring
 Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
 License-Expression: MIT

frequenz_cs_reporting-0.4.4/RELEASE_NOTES.md

@@ -0,0 +1,21 @@
+# Frequenz CS Reporting Library Release Notes
+
+## Summary
+
+
+## Upgrading
+
+- Update dockerfile to have grpcio.
+
+## New Features
+
+- Added a "Filter der Tabelle zurücksetzen" control to reporting tables, allowing
+  users to clear AgGrid filters without rerunning the page.
+
+## Bug Fixes
+
+- Fixed reporting table pagination and sizing by using a stable page size and
+  calculated grid height instead of automatic page sizing.
+- Improved reporting dashboard error handling for timeouts, missing microgrid
+  configuration, invalid filter parameters, service configuration problems, and
+  API/network failures.

{frequenz_cs_reporting-0.4.2 → frequenz_cs_reporting-0.4.4}/src/frequenz/cs_reporting/app_pages/reporting.py

@@ -10,7 +10,6 @@ from datetime import UTC, datetime, timedelta
 
 import pandas as pd
 import streamlit as st
-import streamlit.components.v1 as components
 from frequenz.lib.notebooks.reporting.utils.column_mapper import ColumnMapper
 from frequenz.lib.notebooks.reporting.utils.helpers import (
     normalize_date_for_reporting,
@@ -32,17 +31,16 @@ def _scroll_to_section_if_requested() -> None:
     if st.query_params.get("section") != "data-export":
         return
 
-    # Execute in parent document because Streamlit components render in an iframe.
-    components.html(
+    st.html(
         """
         <script>
-        const target = window.parent.document.getElementById("data-export-section");
+        const target = document.getElementById("data-export-section");
         if (target) {
             target.scrollIntoView({ behavior: "smooth", block: "start" });
         }
         </script>
         """,
-        height=0,
+        unsafe_allow_javascript=True,
     )
 
 
@@ -84,6 +82,68 @@ def _prepare_dataframe(df: pd.DataFrame) -> pd.DataFrame:
     return df
 
 
+def _format_data_loading_error(exc: Exception, microgrid_id: int) -> str:
+    """Return a user-facing error message for a data loading failure."""
+    detail = str(exc).strip()
+    detail_suffix = f"\n\nDetails: {detail}" if detail else ""
+
+    if isinstance(exc, TimeoutError):
+        return (
+            "Zeitüberschreitung beim Laden der Microgrid-Daten. "
+            "Bitte wählen Sie einen anderen Zeitraum oder versuchen Sie es erneut."
+            f"{detail_suffix}"
+        )
+
+    if isinstance(exc, KeyError):
+        return (
+            f"Microgrid {microgrid_id} wurde in den geladenen Konfigurationen "
+            f"nicht gefunden.{detail_suffix}"
+        )
+
+    if isinstance(exc, ValueError):
+        return (
+            "Die ausgewählten Filterparameter sind ungültig. "
+            "Bitte prüfen Sie Zeitraum, Zeitzone und Auflösung."
+            f"{detail_suffix}"
+        )
+
+    if isinstance(exc, RuntimeError):
+        if "environment variable" in detail:
+            return (
+                "Eine benötigte Umgebungsvariable fehlt. "
+                "Bitte prüfen Sie die API- und Service-Konfiguration."
+                f"{detail_suffix}"
+            )
+        if "config directory" in detail or "config files" in detail:
+            return (
+                "Microgrid-Konfigurationen konnten nicht geladen werden. "
+                "Bitte prüfen Sie das konfigurierte TOML-Verzeichnis."
+                f"{detail_suffix}"
+            )
+        if "active event loop" in detail:
+            return (
+                "Interner Laufzeitfehler beim Laden der Daten. "
+                "Der Datenabruf wurde aus einem ungültigen Kontext gestartet."
+                f"{detail_suffix}"
+            )
+        return (
+            "Microgrid-Daten konnten wegen eines Laufzeitfehlers nicht geladen werden."
+            f"{detail_suffix}"
+        )
+
+    if isinstance(exc, OSError):
+        return (
+            "Die Reporting-API konnte nicht erreicht werden. "
+            "Bitte prüfen Sie Netzwerkverbindung, API-URL und Zugangsdaten."
+            f"{detail_suffix}"
+        )
+
+    return (
+        "Beim Laden der Microgrid-Daten ist ein unerwarteter Fehler aufgetreten."
+        f"{detail_suffix}"
+    )
+
+
 # pylint: disable=too-many-locals
 def render() -> None:
     """Render the Frequenz Reporting Dashboard page.
@@ -131,16 +191,14 @@ def render() -> None:
         st.error(str(exc))
         st.stop()
 
-    # Fetch microgrid configuration
-    component_types = list(get_component_types(microgrid_id))
-    mcfg = get_microgrid_config(microgrid_id)
-
     # We extend the fetch end date by 1 day to ensure the API returns data
     # for the full duration of the selected end_time.
 
     # Fetch data with error handling
     try:
         with st.spinner("Microgrid-Daten werden geladen..."):
+            component_types = list(get_component_types(microgrid_id))
+            mcfg = get_microgrid_config(microgrid_id)
             df = get_microgrid_data(
                 microgrid_id=microgrid_id,
                 start_date=start_time,
@@ -148,8 +206,8 @@ def render() -> None:
                 end_date=end_time,
                 resolution=resolution,
             )
-    except (RuntimeError, ValueError, OSError) as e:
-        st.error(f"Daten konnten nicht geladen werden: {e}")
+    except Exception as exc:  # pylint: disable=broad-except
+        st.error(_format_data_loading_error(exc, microgrid_id))
         st.stop()
 
     # Check for empty results

{frequenz_cs_reporting-0.4.2 → frequenz_cs_reporting-0.4.4}/src/frequenz/cs_reporting/components/tables.py

@@ -3,6 +3,8 @@
 
 """AgGrid helpers for rendering reporting tables."""
 
+import json
+
 import pandas as pd
 import streamlit as st
 from st_aggrid import (  # type: ignore[import-untyped]
@@ -10,17 +12,23 @@ from st_aggrid import (  # type: ignore[import-untyped]
     ColumnsAutoSizeMode,
     GridOptionsBuilder,
     GridUpdateMode,
+    JsCode,
 )
 
+_GRID_HEADER_HEIGHT = 40
+_GRID_ROW_HEIGHT = 44
+_GRID_PAGINATION_HEIGHT = 56
+_GRID_BORDER_HEIGHT = 2
+
 
 # pylint: disable=too-many-arguments
 def aggrid_table(
     df: pd.DataFrame,
     *,
     key_prefix: str,
-    page_size: int = 12,
+    page_size: int = 7,
     header_color: str = "#1e4f87",
-    height: int = 420,
+    height: int | None = None,
     theme: str = "balham",  # 'alpine' | 'balham' | 'material' | etc.
     default_col_width: int = 180,
     min_col_width: int = 160,
@@ -46,13 +54,27 @@ def aggrid_table(
     # Initialize session state for page size if it doesn't exist
     if f"{key_prefix}_page_size" not in st.session_state:
         st.session_state[f"{key_prefix}_page_size"] = page_size
+    page_size = int(st.session_state[f"{key_prefix}_page_size"])
+    visible_rows = min(max(len(df), 1), page_size)
+    if height is None:
+        height = (
+            _GRID_HEADER_HEIGHT
+            + (visible_rows * _GRID_ROW_HEIGHT)
+            + _GRID_PAGINATION_HEIGHT
+            + _GRID_BORDER_HEIGHT
+        )
 
     # --- Build grid options from dataframe ---
     gb = GridOptionsBuilder.from_dataframe(df)
     gb.configure_pagination(
         enabled=True,
-        paginationAutoPageSize=True,
-        # paginationPageSize=st.session_state[f'{key_prefix}_page_size'],
+        paginationAutoPageSize=False,
+        paginationPageSize=page_size,
+    )
+    gb.configure_grid_options(
+        headerHeight=_GRID_HEADER_HEIGHT,
+        rowHeight=_GRID_ROW_HEIGHT,
+        paginationPageSizeSelector=False,
     )
 
     gb.configure_default_column(
@@ -70,6 +92,39 @@ def aggrid_table(
 
     # Fit columns on first load
     grid_options = gb.build()
+    grid_options["onGridReady"] = JsCode(f"""
+        function(params) {{
+            const gridKey = {json.dumps(key_prefix)};
+            const messageType = "cs-reporting-reset-aggrid-filters";
+            window.__csReportingAgGridResetHandlers =
+                window.__csReportingAgGridResetHandlers || {{}};
+
+            const previousHandler =
+                window.__csReportingAgGridResetHandlers[gridKey];
+            if (previousHandler) {{
+                window.removeEventListener("message", previousHandler);
+            }}
+
+            const resetFilters = function() {{
+                params.api.setFilterModel(null);
+                params.api.onFilterChanged();
+                params.api.paginationGoToFirstPage();
+            }};
+
+            const handler = function(event) {{
+                if (
+                    event.data &&
+                    event.data.type === messageType &&
+                    event.data.gridKey === gridKey
+                ) {{
+                    resetFilters();
+                }}
+            }};
+
+            window.__csReportingAgGridResetHandlers[gridKey] = handler;
+            window.addEventListener("message", handler);
+        }}
+    """)
 
     # --- Scoped CSS: restrained header + clean grid lines ---
     container_id = f"agc_{key_prefix}"
@@ -107,7 +162,9 @@ def aggrid_table(
             gridOptions=grid_options,
             height=height,
             theme=theme,
+            allow_unsafe_jscode=True,
             update_mode=GridUpdateMode.NO_UPDATE,
+            update_on=[],
             fit_columns_on_grid_load=False,
             columns_auto_size_mode=ColumnsAutoSizeMode.NO_AUTOSIZE,
             key=key_prefix,

{frequenz_cs_reporting-0.4.2 → frequenz_cs_reporting-0.4.4}/src/frequenz/cs_reporting/views/solar_results.py

@@ -9,6 +9,7 @@ import base64
 import math
 from io import BytesIO
 from typing import Any
+from urllib.parse import quote
 
 import matplotlib.pyplot as plt
 import streamlit as st
@@ -52,7 +53,10 @@ def _render_production_table(plot_data: SolarAnalysisData) -> None:
     estimated_rows = max(1, math.ceil(len(table_view) / cards_per_row))
     height = min(140 + estimated_rows * 430, 1600)
 
-    st.components.v1.html(dashboard_html, height=height, scrolling=True)
+    st.iframe(
+        f"data:text/html;charset=utf-8,{quote(dashboard_html)}",
+        height=height,
+    )
 
 
 def _ensure_card_styles() -> None:

{frequenz_cs_reporting-0.4.2 → frequenz_cs_reporting-0.4.4}/src/frequenz/cs_reporting/views/table_renderers.py

@@ -5,6 +5,8 @@
 
 from __future__ import annotations
 
+import json
+
 import pandas as pd
 import streamlit as st
 from frequenz.lib.notebooks.reporting.utils.column_mapper import ColumnMapper
@@ -109,6 +111,72 @@ def _style_download_button(
     )
 
 
+def _render_reset_filters_button(key_prefix: str) -> None:
+    """Render a no-rerun button that clears the matching AgGrid filters."""
+    button_id = f"{key_prefix}_reset_table_filters"
+    button_html = f"""
+        <button id="{button_id}" type="button">
+            Filter der Tabelle zurücksetzen
+        </button>
+        <script>
+        (function() {{
+            const button = document.getElementById({json.dumps(button_id)});
+            const gridKey = {json.dumps(key_prefix)};
+            const messageType = "cs-reporting-reset-aggrid-filters";
+
+            if (!button) {{
+                return;
+            }}
+
+            button.addEventListener("click", function(event) {{
+                event.preventDefault();
+                event.stopPropagation();
+
+                for (const iframe of window.parent.document.querySelectorAll("iframe")) {{
+                    try {{
+                        iframe.contentWindow.postMessage(
+                            {{ type: messageType, gridKey: gridKey }},
+                            "*"
+                        );
+                    }} catch (error) {{
+                        // Ignore if a browser blocks access to an iframe window.
+                    }}
+                }}
+            }});
+        }})();
+        </script>
+        <style>
+        html,
+        body {{
+            margin: 0;
+            padding: 0;
+            overflow: hidden;
+            background: transparent;
+        }}
+        #{button_id} {{
+            background-color: #fff4bf;
+            border: 1px solid #e4c34a;
+            color: #4f3f00;
+            border-radius: 6px;
+            cursor: pointer;
+            font-family: inherit;
+            font-size: 0.8rem;
+            font-weight: 600;
+            line-height: 1.1;
+            min-height: 1.75rem;
+            padding: 0.15rem 0.55rem;
+            white-space: nowrap;
+        }}
+        #{button_id}:hover {{
+            background-color: #ffe88a;
+            border-color: #c7a629;
+            color: #3f3200;
+        }}
+        </style>
+    """
+    st.html(button_html, unsafe_allow_javascript=True)
+
+
 def render_table_section(
     df: pd.DataFrame | None,
     *,
@@ -130,11 +198,13 @@ def render_table_section(
     """
     safe_df = df if (df is not None and not df.empty) else pd.DataFrame()
     display_df = _round_numeric_columns(safe_df)
-    header_cols = st.columns([8, 1])
+    header_cols = st.columns([1, 0.125])
     if caption:
         header_cols[0].caption(caption)
     else:
         header_cols[0].markdown("", unsafe_allow_html=True)
+    with header_cols[0]:
+        _render_reset_filters_button(key_prefix)
 
     if not safe_df.empty:
         csv_bytes = display_df.to_csv(index=False, sep=";", decimal=",").encode("utf-8")
@@ -164,8 +234,10 @@ def render_master_df(master_df: pd.DataFrame, mapper: ColumnMapper) -> None:
         Streamlit components are rendered directly.
     """
     if master_df is not None and not master_df.empty:
-        header_cols = st.columns([10, 1])
-        header_cols[0].caption("Standardized master dataframe")
+        header_cols = st.columns([1, 0.125])
+        header_cols[0].caption("Standardisierter Haupt-DataFrame")
+        with header_cols[0]:
+            _render_reset_filters_button("master_df")
         display_df = _round_numeric_columns(
             mapper.to_display(master_df).rename(columns=_MASTER_DF_DISPLAY_RENAMES)
         )
@@ -174,7 +246,7 @@ def render_master_df(master_df: pd.DataFrame, mapper: ColumnMapper) -> None:
         )
         _style_download_button(header_cols[1])
         header_cols[1].download_button(
-            label="Download Gesamt-Datensatz",
+            label="CSV herunterladen",
             data=master_csv,
             file_name="master_df.csv",
             mime="text/csv",
@@ -214,12 +286,19 @@ def render_data_tabs(
         st.info("Keine Datentabellen verfügbar.")
         return
 
-    tab_labels = [spec["label"] for spec in available_specs]
+    tab_labels = []
     if include_master:
         tab_labels.append("Gesamt-Datensatz")
+    tab_labels.extend(spec["label"] for spec in available_specs)
     tabs = st.tabs(tab_labels)
 
-    for tab, spec in zip(tabs, available_specs):
+    table_tabs = tabs
+    if include_master:
+        with tabs[0]:
+            render_master_df(master_df, mapper)
+        table_tabs = tabs[1:]
+
+    for tab, spec in zip(table_tabs, available_specs):
         value = tables_dict.get(spec["table_key"])
         with tab:
             render_table_section(
@@ -228,7 +307,3 @@ def render_data_tabs(
                 caption=spec.get("caption"),
                 empty_info=spec.get("empty_info"),
             )
-
-    if include_master:
-        with tabs[-1]:
-            render_master_df(master_df, mapper)

{frequenz_cs_reporting-0.4.2 → frequenz_cs_reporting-0.4.4}/src/frequenz_cs_reporting.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: frequenz-cs-reporting
-Version: 0.4.2
+Version: 0.4.4
 Summary: Streamlit Library for reporting and solar monitoring
 Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
 License-Expression: MIT

{frequenz_cs_reporting-0.4.2 → frequenz_cs_reporting-0.4.4}/src/frequenz_cs_reporting.egg-info/scm_version.json

@@ -1,7 +1,7 @@
 {
-  "tag": "0.4.2",
+  "tag": "0.4.4",
   "distance": 0,
-  "node": "g961f18cd7b218235c1e9d85e021e877c3a3f1b04",
+  "node": "g547b1f4fb14278e0722c43562d10c16b33a6d896",
   "dirty": false,
   "branch": "HEAD",
   "node_date": "2026-08-04"

frequenz_cs_reporting-0.4.2/RELEASE_NOTES.md

@@ -1,13 +0,0 @@
-# Frequenz CS Reporting Library Release Notes
-
-## Summary
-
-
-## Upgrading
-
-- Update dockerfile to have grpcio.
-
-## New Features
-
-
-## Bug Fixes