Add module-level docstrings to dashboard components and routes for improved documentation and clarity

andrewm4894 · andrewm4894 · commit ec5a813c6a56 · 2025-03-22T23:39:19.000Z
diff --git a/dashboard/README.md b/dashboard/README.md
@@ -2,10 +2,12 @@
 
 - [`app.py`](app.py): [FastHTML](https://fastht.ml/) dashboard for the project (WIP).
 - [`charts.py`](charts.py): Chart manager for the dashboard.
-- [`components.py`](components.py): Components for the dashboard.
+- [`components/`](components/): Components for the dashboard.
 - [`constants.py`](constants.py): Constants for the dashboard.
 - [`data.py`](data.py): Data manager for the dashboard.
-- [`routes.py`](routes.py): Routes for the dashboard.
+- [`routes/`](routes/): Routes for the dashboard.
+- [`batch_stats.py`](batch_stats.py): Batch stats for the dashboard.
+- [`static/`](static/): Static files for the dashboard.
 - [`state.py`](state.py): State manager for the dashboard.
 - [`utils.py`](utils.py): Utility functions for the dashboard.
 
diff --git a/dashboard/app.py b/dashboard/app.py
@@ -1,4 +1,6 @@
 """
+dashboard/app.py
+
 Anomstack Dashboard
 
 This is a dashboard for the Anomstack project. It is a web application that allows you to view and analyze metrics from the Anomstack project.
diff --git a/dashboard/batch_stats.py b/dashboard/batch_stats.py
@@ -1,3 +1,12 @@
+"""
+dashboard/batch_stats.py
+
+Batch Stats
+
+This module contains functions for calculating statistics for a batch of metrics.
+
+"""
+
 from datetime import datetime, timezone
 import pandas as pd
 from typing import Dict, Any
diff --git a/dashboard/charts.py b/dashboard/charts.py
@@ -1,5 +1,10 @@
 """
+dashboard/charts.py
+
 Chart manager for the dashboard.
+
+This module contains the ChartManager class, which is responsible for creating charts for the dashboard.
+
 """
 
 from fasthtml.common import *
diff --git a/dashboard/components/__init__.py b/dashboard/components/__init__.py
@@ -1,6 +1,12 @@
 """
+dashboard/components/__init__.py
+
 Components module initialization.
+
+This module contains the components for the dashboard.
+
 """
+
 from .toolbar import create_toolbar_buttons
 from .search import create_search_form, create_last_n_form
 from .batch import create_batch_card
@@ -16,4 +22,4 @@
     'create_settings_dropdown',
     'create_header',
     'create_controls',
-] 
+]
diff --git a/dashboard/components/batch.py b/dashboard/components/batch.py
@@ -1,6 +1,12 @@
 """
+dashboard/components/batch.py
+
 Batch-related components.
+
+This module contains the components for the batch view.
+
 """
+
 from fasthtml.common import *
 from monsterui.all import *
 from dashboard.state import get_state
diff --git a/dashboard/components/common.py b/dashboard/components/common.py
@@ -1,11 +1,18 @@
 """
+dashboard/components/common.py
+
 Common components shared across the dashboard.
+
+This module contains the common components for the dashboard.
+
 """
+
 from fasthtml.common import *
 from monsterui.all import *
 from .search import create_search_form, create_last_n_form
 from .toolbar import create_toolbar_buttons
 
+
 def create_controls(batch_name: str) -> Card:
     """Create the main controls for the dashboard."""
     return Card(
diff --git a/dashboard/components/header.py b/dashboard/components/header.py
@@ -1,6 +1,12 @@
 """
+dashboard/components/header.py
+
 Header components.
+
+This module contains the components for the dashboard header.
+
 """
+
 from fasthtml.common import *
 from monsterui.all import *
 
diff --git a/dashboard/components/search.py b/dashboard/components/search.py
@@ -1,6 +1,12 @@
 """
+dashboard/components/search.py
+
 Search and filtering components.
+
+This module contains the components for the search and filtering functionality.
+
 """
+
 from fasthtml.common import *
 from monsterui.all import *
 from dashboard.app import app
diff --git a/dashboard/components/settings.py b/dashboard/components/settings.py
@@ -1,6 +1,12 @@
 """
+dashboard/components/settings.py
+
 Settings-related components.
+
+This module contains the components for the settings dropdown menu.
+
 """
+
 from fasthtml.common import *
 from monsterui.all import *
 from dashboard.state import get_state
diff --git a/dashboard/components/toolbar.py b/dashboard/components/toolbar.py
@@ -1,11 +1,18 @@
 """
+dashboard/components/toolbar.py
+
 Toolbar-related components.
+
+This module contains the components for the toolbar.
+
 """
+
 from fasthtml.common import *
 from monsterui.all import *
 from .batch import create_batches_dropdown
 from .settings import create_settings_dropdown
 
+
 def create_toolbar_buttons(batch_name: str) -> Div:
     """Create the toolbar buttons."""
     return Div(
@@ -43,4 +50,4 @@ def create_toolbar_buttons(batch_name: str) -> Div:
             uk_tooltip="View project on GitHub",
         ),
         cls="flex items-center space-x-2 flex-wrap",
-    ) 
+    )
diff --git a/dashboard/constants.py b/dashboard/constants.py
@@ -1,4 +1,11 @@
-"""Dashboard constants."""
+"""
+dashboard/constants.py
+
+Dashboard constants.
+
+This module contains constants for the dashboard.
+
+"""
 
 DEFAULT_LOAD_N_CHARTS = 10
 DEFAULT_LAST_N = "30n"
diff --git a/dashboard/data.py b/dashboard/data.py
@@ -1,5 +1,10 @@
 """
+dashboard/data.py
+
 Data manager for the dashboard.
+
+This module contains functions for getting data from the database for the dashboard.
+
 """
 
 import pandas as pd
diff --git a/dashboard/routes/__init__.py b/dashboard/routes/__init__.py
@@ -1,3 +1,11 @@
+"""
+dashboard/routes/__init__.py
+
+Routes for the dashboard.
+
+This module contains the routes for the dashboard.
+
+"""
 
 from .index import *
 from .batch_view import *
diff --git a/dashboard/routes/batch_view.py b/dashboard/routes/batch_view.py
@@ -1,3 +1,12 @@
+"""
+dashboard/routes/batch_view.py
+
+Batch View
+
+This module contains the route for the batch view.
+
+"""
+
 import pandas as pd
 from fasthtml.common import *
 from monsterui.all import *
@@ -8,7 +17,7 @@
 from dashboard.constants import DEFAULT_LAST_N, DEFAULT_LOAD_N_CHARTS
 
 
-def _get_batch_data(batch_name: str):
+def get_batch_data(batch_name: str):
     """Get batch data, either from cache or by fetching."""
     try:
         return get_data(app.state.specs_enabled[batch_name],
@@ -27,7 +36,7 @@ def get_batch_view(batch_name: str,
                    initial_load: int = DEFAULT_LOAD_N_CHARTS):
     """Get the batch view."""
     if batch_name not in app.state.df_cache or batch_name not in app.state.stats_cache:
-        app.state.df_cache[batch_name] = _get_batch_data(batch_name)
+        app.state.df_cache[batch_name] = get_batch_data(batch_name)
         app.state.calculate_metric_stats(batch_name)
 
     metric_stats = app.state.stats_cache[batch_name]
diff --git a/dashboard/routes/index.py b/dashboard/routes/index.py
@@ -1,3 +1,12 @@
+"""
+dashboard/routes/index.py
+
+Index
+
+This module contains the route for the index page.
+
+"""
+
 from fasthtml.common import *
 from monsterui.all import *
 from fasthtml.svg import *
@@ -7,6 +16,8 @@
 from dashboard.components import create_batch_card
 from dashboard.batch_stats import calculate_batch_stats
 from dashboard.data import get_data
+from dashboard.constants import DEFAULT_LAST_N
+
 
 log = logging.getLogger("anomstack")
 
diff --git a/dashboard/routes/search.py b/dashboard/routes/search.py
@@ -1,6 +1,12 @@
 """
+dashboard/routes/search.py
+
 Routes for search and load more functionality.
+
+This module contains the routes for the search and load more functionality.
+
 """
+
 from fasthtml.common import *
 from monsterui.all import *
 
diff --git a/dashboard/routes/toggles.py b/dashboard/routes/toggles.py
@@ -1,6 +1,12 @@
 """
+dashboard/routes/toggles.py
+
 Routes for handling toggle functionality.
+
+This module contains the routes for handling toggle functionality.
+
 """
+
 from fasthtml.common import *
 from monsterui.all import *
 
diff --git a/dashboard/state.py b/dashboard/state.py
@@ -1,5 +1,10 @@
 """
+dashboard/state.py
+
 State manager for the dashboard.
+
+This module contains the AppState class, which is responsible for managing the state of the dashboard.
+
 """
 
 import logging
diff --git a/dashboard/utils.py b/dashboard/utils.py
@@ -1,5 +1,10 @@
 """
+dashboard/utils.py
+
 Utils for the dashboard.
+
+This module contains utility functions for the dashboard.
+
 """
 
 import logging
