504 lines
44 KiB
HTML
504 lines
44 KiB
HTML
<!DOCTYPE html>
|
||
|
||
<html lang="en" data-content_root="./">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
|
||
<title>streamlit_dashboard.utility_classes namespace — Streamlit Dashboard 1.0 documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
|
||
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
|
||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
|
||
<script src="_static/documentation_options.js?v=f2a433a1"></script>
|
||
<script src="_static/doctools.js?v=fd6eb6e6"></script>
|
||
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="prev" title="streamlit_dashboard.streamlit_pages namespace" href="streamlit_dashboard.streamlit_pages.html" />
|
||
|
||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||
|
||
|
||
|
||
|
||
|
||
</head><body>
|
||
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
|
||
|
||
<div class="body" role="main">
|
||
|
||
<section id="module-streamlit_dashboard.utility_classes">
|
||
<span id="streamlit-dashboard-utility-classes-namespace"></span><h1>streamlit_dashboard.utility_classes namespace<a class="headerlink" href="#module-streamlit_dashboard.utility_classes" title="Link to this heading">¶</a></h1>
|
||
<section id="submodules">
|
||
<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">¶</a></h2>
|
||
</section>
|
||
<section id="module-streamlit_dashboard.utility_classes.base_report_page">
|
||
<span id="streamlit-dashboard-utility-classes-base-report-page-module"></span><h2>streamlit_dashboard.utility_classes.base_report_page module<a class="headerlink" href="#module-streamlit_dashboard.utility_classes.base_report_page" title="Link to this heading">¶</a></h2>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.base_report_page.BaseReportPage">
|
||
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">streamlit_dashboard.utility_classes.base_report_page.</span></span><span class="sig-name descname"><span class="pre">BaseReportPage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#streamlit_dashboard.utility_classes.base_report_page.BaseReportPage" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#streamlit_dashboard.utility_classes.base_report_page.Renderable" title="streamlit_dashboard.utility_classes.base_report_page.Renderable"><code class="xref py py-class docutils literal notranslate"><span class="pre">Renderable</span></code></a></p>
|
||
<p>Standardizes the rendering pipeline for all analytical report pages.</p>
|
||
<p>This class breaks down UI generation into a predictable, synchronous lifecycle:
|
||
1. Render controls (capture inputs).
|
||
2. Generate figures (process data).
|
||
3. Render figures (display outputs).
|
||
This strict pipeline allows higher-level orchestrators to intercept the process
|
||
mid-cycle (e.g., to mutate generated figures before they are drawn).</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>title</strong> (<em>str</em>) – The title of the page, acting as its base instance ID.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.base_report_page.BaseReportPage.generate_figures">
|
||
<span class="sig-name descname"><span class="pre">generate_figures</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parameters</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#streamlit_dashboard.utility_classes.base_report_page.BaseReportPage.generate_figures" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Processes parameters and generates the underlying data/figures for the report.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>parameters</strong> (<em>Dict</em><em>[</em><em>str</em><em>, </em><em>Any</em><em>]</em>) – The dictionary of user inputs captured from render_controls.</p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>A dictionary of computed outputs or Plotly figures.</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Dict[str, Any]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.base_report_page.BaseReportPage.get_page_name">
|
||
<span class="property"><span class="k"><span class="pre">static</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">get_page_name</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#streamlit_dashboard.utility_classes.base_report_page.BaseReportPage.get_page_name" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Retrieves the human-readable name of the report for UI selection menus.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The display name of the report.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>str</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.base_report_page.BaseReportPage.get_syncable_figure_keys">
|
||
<span class="sig-name descname"><span class="pre">get_syncable_figure_keys</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#streamlit_dashboard.utility_classes.base_report_page.BaseReportPage.get_syncable_figure_keys" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Identifies which generated figures support external axis synchronization for when
|
||
two of the same report are displayed side by side.</p>
|
||
<p>This should really only be used for graphs for which axis synchronization makes sense
|
||
(like bar charts that show quantities not percentages)</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>A list of dictionary keys corresponding to figures in output_data
|
||
that can have their Y-axes scaled dynamically by a parent orchestrator.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>List[str]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.base_report_page.BaseReportPage.render">
|
||
<span class="sig-name descname"><span class="pre">render</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">container</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DeltaGenerator</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#streamlit_dashboard.utility_classes.base_report_page.BaseReportPage.render" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Executes the standardized report lifecycle.</p>
|
||
<p>Sequentially chains control rendering, data generation, and figure drawing,
|
||
passing state safely between each phase and halting if user parameters are missing.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>container</strong> (<em>DeltaGenerator</em>) – The Streamlit layout container for the entire report.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.base_report_page.BaseReportPage.render_controls">
|
||
<span class="sig-name descname"><span class="pre">render_controls</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">container</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DeltaGenerator</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#streamlit_dashboard.utility_classes.base_report_page.BaseReportPage.render_controls" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Renders the input widgets required to parameterize the report.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>container</strong> (<em>DeltaGenerator</em>) – The Streamlit container to draw the widgets onto.</p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>A dictionary of user-selected parameters, or None if inputs are invalid.</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Dict[str, Any]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.base_report_page.BaseReportPage.render_figures">
|
||
<span class="sig-name descname"><span class="pre">render_figures</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">container</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DeltaGenerator</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#streamlit_dashboard.utility_classes.base_report_page.BaseReportPage.render_figures" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Draws the previously generated figures and data onto the screen.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>container</strong> (<em>DeltaGenerator</em>) – The Streamlit container to draw the visuals onto.</p></li>
|
||
<li><p><strong>output_data</strong> (<em>Dict</em><em>[</em><em>str</em><em>, </em><em>Any</em><em>]</em>) – The computed results returned by generate_figures.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.base_report_page.Renderable">
|
||
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">streamlit_dashboard.utility_classes.base_report_page.</span></span><span class="sig-name descname"><span class="pre">Renderable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">instance_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#streamlit_dashboard.utility_classes.base_report_page.Renderable" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||
<p>Abstract base class for UI components drawn to a Streamlit container.</p>
|
||
<p>Provides a strict contract for rendering and manages unique identifier generation.
|
||
This structure is critical in Streamlit to prevent widget state collisions
|
||
when multiple instances of the same UI component are rendered simultaneously.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>instance_id</strong> (<em>str</em>) – A unique identifier for this specific rendered instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.base_report_page.Renderable.get_widget_key">
|
||
<span class="sig-name descname"><span class="pre">get_widget_key</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">widget_unique_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#streamlit_dashboard.utility_classes.base_report_page.Renderable.get_widget_key" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Generates a globally unique Streamlit widget key for this specific instance.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>widget_unique_id</strong> (<em>str</em>) – The local identifier for the specific widget.</p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>A concatenated string combining the instance ID and widget ID.</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>str</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.base_report_page.Renderable.render">
|
||
<span class="property"><span class="k"><span class="pre">abstractmethod</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">render</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">container</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DeltaGenerator</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#streamlit_dashboard.utility_classes.base_report_page.Renderable.render" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Renders the component’s UI elements onto the specified Streamlit container.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>container</strong> (<em>DeltaGenerator</em>) – The Streamlit layout element where this component will be drawn.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="module-streamlit_dashboard.utility_classes.dashboard_config_parser">
|
||
<span id="streamlit-dashboard-utility-classes-dashboard-config-parser-module"></span><h2>streamlit_dashboard.utility_classes.dashboard_config_parser module<a class="headerlink" href="#module-streamlit_dashboard.utility_classes.dashboard_config_parser" title="Link to this heading">¶</a></h2>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig">
|
||
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">streamlit_dashboard.utility_classes.dashboard_config_parser.</span></span><span class="sig-name descname"><span class="pre">DashboardConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>Central manager for application configuration state and schema validation.</p>
|
||
<p>This class handles the serialization, parsing, and strict validation of the YAML
|
||
configuration file. It acts as the single source of truth for all external Neoserra
|
||
data endpoints and logging behaviors, abstracting the dictionary traversal away from
|
||
the reporting classes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>filename</strong> (<em>str</em>) – The filepath to the target YAML configuration file.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.get_clients_list_urls">
|
||
<span class="sig-name descname"><span class="pre">get_clients_list_urls</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#streamlit_dashboard.utility_classes.dashboard_config_parser.ExportModulePair" title="streamlit_dashboard.utility_classes.dashboard_config_parser.ExportModulePair"><span class="pre">ExportModulePair</span></a></span></span><a class="headerlink" href="#streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.get_clients_list_urls" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Retrieves the paired endpoints for the client list dataset.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>An object containing the current and previous fiscal period URLs.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#streamlit_dashboard.utility_classes.dashboard_config_parser.ExportModulePair" title="streamlit_dashboard.utility_classes.dashboard_config_parser.ExportModulePair">ExportModulePair</a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.get_funding_milestones_urls">
|
||
<span class="sig-name descname"><span class="pre">get_funding_milestones_urls</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#streamlit_dashboard.utility_classes.dashboard_config_parser.ExportModulePair" title="streamlit_dashboard.utility_classes.dashboard_config_parser.ExportModulePair"><span class="pre">ExportModulePair</span></a></span></span><a class="headerlink" href="#streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.get_funding_milestones_urls" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Retrieves the paired endpoints for the funding milestones dataset.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>An object containing the current and previous fiscal period URLs.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#streamlit_dashboard.utility_classes.dashboard_config_parser.ExportModulePair" title="streamlit_dashboard.utility_classes.dashboard_config_parser.ExportModulePair">ExportModulePair</a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.get_log_level">
|
||
<span class="sig-name descname"><span class="pre">get_log_level</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.get_log_level" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Translates the human-readable logging level from the configuration file into system constants.</p>
|
||
<p>Maps string values (e.g., “DEBUG”, “WARNING”) to their corresponding integer values
|
||
required by the native Python <cite>logging</cite> module.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The integer constant representing the logging severity level.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>int</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.get_log_path">
|
||
<span class="sig-name descname"><span class="pre">get_log_path</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.get_log_path" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Retrieves the configured file path for the application’s rotating file logger.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The target filepath, or None if the configuration is missing.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>str | None</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.get_nbs_milestones_urls">
|
||
<span class="sig-name descname"><span class="pre">get_nbs_milestones_urls</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#streamlit_dashboard.utility_classes.dashboard_config_parser.ExportModulePair" title="streamlit_dashboard.utility_classes.dashboard_config_parser.ExportModulePair"><span class="pre">ExportModulePair</span></a></span></span><a class="headerlink" href="#streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.get_nbs_milestones_urls" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Retrieves the paired endpoints for the New Business Starts dataset.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>An object containing the current and previous fiscal period URLs.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#streamlit_dashboard.utility_classes.dashboard_config_parser.ExportModulePair" title="streamlit_dashboard.utility_classes.dashboard_config_parser.ExportModulePair">ExportModulePair</a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.get_trainings_urls">
|
||
<span class="sig-name descname"><span class="pre">get_trainings_urls</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#streamlit_dashboard.utility_classes.dashboard_config_parser.ExportModulePair" title="streamlit_dashboard.utility_classes.dashboard_config_parser.ExportModulePair"><span class="pre">ExportModulePair</span></a></span></span><a class="headerlink" href="#streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.get_trainings_urls" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Retrieves the paired endpoints for the training events dataset.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>An object containing the current and previous fiscal period URLs.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#streamlit_dashboard.utility_classes.dashboard_config_parser.ExportModulePair" title="streamlit_dashboard.utility_classes.dashboard_config_parser.ExportModulePair">ExportModulePair</a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.load">
|
||
<span class="sig-name descname"><span class="pre">load</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.load" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Reads the configuration file from disk and enforces strict schema validation.</p>
|
||
<p>Acts as a fail-fast gateway for the application environment. It manually verifies the
|
||
existence of every required organizational key (export modules, fiscal periods, and logging
|
||
parameters). If the YAML file is structurally malformed or missing endpoints, it immediately
|
||
raises explicit KeyErrors to halt application boot, preventing cascading fetch failures later.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.save">
|
||
<span class="sig-name descname"><span class="pre">save</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.save" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Serializes the current in-memory configuration state to the YAML file on disk.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.set_clients_list_current_fy_url">
|
||
<span class="sig-name descname"><span class="pre">set_clients_list_current_fy_url</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">current_fy_url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.set_clients_list_current_fy_url" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Updates the in-memory endpoint URL for the current fiscal period’s client dataset.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.set_clients_list_prev_fy_url">
|
||
<span class="sig-name descname"><span class="pre">set_clients_list_prev_fy_url</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prev_fy_url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.set_clients_list_prev_fy_url" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Updates the in-memory endpoint URL for the previous fiscal period’s client dataset.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.set_funding_milestones_current_fy_url">
|
||
<span class="sig-name descname"><span class="pre">set_funding_milestones_current_fy_url</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">current_fy_url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.set_funding_milestones_current_fy_url" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Updates the in-memory endpoint URL for the current fiscal period’s funding milestones dataset.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.set_funding_milestones_prev_fy_url">
|
||
<span class="sig-name descname"><span class="pre">set_funding_milestones_prev_fy_url</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prev_fy_url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.set_funding_milestones_prev_fy_url" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Updates the in-memory endpoint URL for the previous fiscal period’s funding milestones dataset.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.set_nbs_milestones_current_fy_url">
|
||
<span class="sig-name descname"><span class="pre">set_nbs_milestones_current_fy_url</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">current_fy_url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.set_nbs_milestones_current_fy_url" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Updates the in-memory endpoint URL for the current fiscal period’s New Business Starts dataset.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.set_nbs_milestones_prev_fy_url">
|
||
<span class="sig-name descname"><span class="pre">set_nbs_milestones_prev_fy_url</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prev_fy_url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.set_nbs_milestones_prev_fy_url" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Updates the in-memory endpoint URL for the previous fiscal period’s New Business Starts dataset.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.set_trainings_current_fy_url">
|
||
<span class="sig-name descname"><span class="pre">set_trainings_current_fy_url</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">current_fy_url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.set_trainings_current_fy_url" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Updates the in-memory endpoint URL for the current fiscal period’s training events dataset.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.set_trainings_prev_fy_url">
|
||
<span class="sig-name descname"><span class="pre">set_trainings_prev_fy_url</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prev_fy_url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.set_trainings_prev_fy_url" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Updates the in-memory endpoint URL for the previous fiscal period’s training events dataset.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.write_template">
|
||
<span class="property"><span class="k"><span class="pre">static</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">write_template</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#streamlit_dashboard.utility_classes.dashboard_config_parser.DashboardConfig.write_template" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Bootstraps a new environment by generating a default configuration file on disk.</p>
|
||
<p>Writes the hardcoded <cite>TEMPLATE_DICT</cite> schema to the specified path to ensure administrators
|
||
have the correct structural format when deploying the dashboard for the first time.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>filename</strong> (<em>str</em>) – The target filepath for the generated YAML file.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.dashboard_config_parser.ExportModulePair">
|
||
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">streamlit_dashboard.utility_classes.dashboard_config_parser.</span></span><span class="sig-name descname"><span class="pre">ExportModulePair</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">current_fy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prev_fy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#streamlit_dashboard.utility_classes.dashboard_config_parser.ExportModulePair" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>Data structure pairing data export endpoints across adjacent fiscal periods.</p>
|
||
<p>This class groups the URLs for the current and previous fiscal years, allowing
|
||
the application to easily pass paired historical and active data sources to
|
||
downstream report pipelines.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.dashboard_config_parser.ExportModulePair.current_fy">
|
||
<span class="sig-name descname"><span class="pre">current_fy</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></span><a class="headerlink" href="#streamlit_dashboard.utility_classes.dashboard_config_parser.ExportModulePair.current_fy" title="Link to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.dashboard_config_parser.ExportModulePair.prev_fy">
|
||
<span class="sig-name descname"><span class="pre">prev_fy</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></span><a class="headerlink" href="#streamlit_dashboard.utility_classes.dashboard_config_parser.ExportModulePair.prev_fy" title="Link to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="module-streamlit_dashboard.utility_classes.figure_with_max_y">
|
||
<span id="streamlit-dashboard-utility-classes-figure-with-max-y-module"></span><h2>streamlit_dashboard.utility_classes.figure_with_max_y module<a class="headerlink" href="#module-streamlit_dashboard.utility_classes.figure_with_max_y" title="Link to this heading">¶</a></h2>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.figure_with_max_y.FigureWithMaxY">
|
||
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">streamlit_dashboard.utility_classes.figure_with_max_y.</span></span><span class="sig-name descname"><span class="pre">FigureWithMaxY</span></span><a class="headerlink" href="#streamlit_dashboard.utility_classes.figure_with_max_y.FigureWithMaxY" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">TypedDict</span></code></p>
|
||
<p>A helper container class that gets used by report pages to encapsulate
|
||
Plotly figures along with the maximum y value represented on the figures.</p>
|
||
<p>This aids in axis synchronization when two of the same report are shown side by side</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.figure_with_max_y.FigureWithMaxY.figure">
|
||
<span class="sig-name descname"><span class="pre">figure</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Figure</span></span><a class="headerlink" href="#streamlit_dashboard.utility_classes.figure_with_max_y.FigureWithMaxY.figure" title="Link to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.figure_with_max_y.FigureWithMaxY.max_y">
|
||
<span class="sig-name descname"><span class="pre">max_y</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></span><a class="headerlink" href="#streamlit_dashboard.utility_classes.figure_with_max_y.FigureWithMaxY.max_y" title="Link to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="streamlit_dashboard.utility_classes.figure_with_max_y.find_fig_max_y_and_generate_wrapper">
|
||
<span class="sig-prename descclassname"><span class="pre">streamlit_dashboard.utility_classes.figure_with_max_y.</span></span><span class="sig-name descname"><span class="pre">find_fig_max_y_and_generate_wrapper</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fig</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Figure</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#streamlit_dashboard.utility_classes.figure_with_max_y.FigureWithMaxY" title="streamlit_dashboard.utility_classes.figure_with_max_y.FigureWithMaxY"><span class="pre">FigureWithMaxY</span></a></span></span><a class="headerlink" href="#streamlit_dashboard.utility_classes.figure_with_max_y.find_fig_max_y_and_generate_wrapper" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Helper to automatically extract the max Y value from a Plotly figure
|
||
and wrap it in the FigureWithMaxY utility class.</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="sphinxsidebar" role="navigation" aria-label="Main">
|
||
<div class="sphinxsidebarwrapper">
|
||
<h1 class="logo"><a href="index.html">Streamlit Dashboard</a></h1>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<search id="searchbox" style="display: none" role="search">
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="search.html" method="get">
|
||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</search>
|
||
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
|
||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">streamlit_dashboard</a><ul class="current">
|
||
<li class="toctree-l2 current"><a class="reference internal" href="streamlit_dashboard.html">streamlit_dashboard namespace</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
<div class="relations">
|
||
<h3>Related Topics</h3>
|
||
<ul>
|
||
<li><a href="index.html">Documentation overview</a><ul>
|
||
<li><a href="modules.html">streamlit_dashboard</a><ul>
|
||
<li><a href="streamlit_dashboard.html">streamlit_dashboard namespace</a><ul>
|
||
<li>Previous: <a href="streamlit_dashboard.streamlit_pages.html" title="previous chapter">streamlit_dashboard.streamlit_pages namespace</a></li>
|
||
</ul></li>
|
||
</ul></li>
|
||
</ul></li>
|
||
</ul>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="footer">
|
||
©2026, SBDC Team.
|
||
|
||
|
|
||
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 9.1.0</a>
|
||
& <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
|
||
|
||
|
|
||
<a href="_sources/streamlit_dashboard.utility_classes.rst.txt"
|
||
rel="nofollow">Page source</a>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html> |