Dash urls and callbacks

Save to/load from urls and additional callbacks refactor

Author: jlubken

src/chime_dash/__init__.py

@@ -8,32 +8,31 @@
 from typing import TypeVar
 from chime_dash.app.config import from_object
 from penn_chime.settings import get_defaults
-from chime_dash.app.components import Body
+from chime_dash.app.pages.root import Root
 from chime_dash.app.utils.callbacks import wrap_callbacks
 
 DashAppInstance = TypeVar('DashAppInstance')
-DEFAULTS = get_defaults()
 
-def create_app(context:str='prod')-> DashAppInstance:
+
+def create_app(context: str = 'prod') -> DashAppInstance:
     """
     create_app initializes the app instance
-    
+
     Args:
         context (str, optional): One of either 'prod', 'dev', 'testing.
         Defaults to 'prod' where dash.Dash.run_server(debug=False).
         Change to 'dev' or 'test' to set debug to true.
-    
+
     Returns:
         Env: Config variables based on context argument received
         DashAppInstance: Dash instance with appropriate configuration settings
     """
 
     Env = from_object(context)
-    
+
     LANGUAGE = Env.LANG
-    body = Body(LANGUAGE, DEFAULTS)
-    
-    
+    body = Root(LANGUAGE, get_defaults())
+
     App = Dash(
         __name__,
         external_stylesheets=body.external_stylesheets,
@@ -44,7 +43,4 @@ def create_app(context:str='prod')-> DashAppInstance:
     App.layout = body.html
     wrap_callbacks(App)
 
-    
-
     return Env, App
-

src/chime_dash/app/components/__init__.py

@@ -1,79 +1,12 @@
-"""Combines all components
+"""app/components
 
-The `sidebar` component combines all the inputs while other components potentially
-have callbacks.
+reusable components that desc a bit of UI - nothing should be defined here only initialized
 
-To add or remove components, adjust the `setup`.
-If callbacks are present, also adjust `CALLBACK_INPUTS`, `CALLBACK_OUTPUTS` and
-`callback_body`.
-"""
-from collections import OrderedDict
-
-from dash_bootstrap_components import Container, Row
-from dash_bootstrap_components.themes import BOOTSTRAP
-from dash_html_components import Div
-
-from chime_dash.app.components.base import Component
-from chime_dash.app.components.navbar import Navbar
-from chime_dash.app.pages.index import Index
-from chime_dash.app.pages.sidebar import Sidebar
-
-
-def singleton(class_):
-    instances = {}
-
-    def get_instance(*args, **kwargs):
-        if class_ not in instances:
-            instances[class_] = class_(*args, **kwargs)
-        return instances[class_]
-    return get_instance
+for pages definitions see -> app/pages
+for core logic see --> app/services
+for utility classes and functions see --> utils
 
-
-@singleton
-class Body(Component):
-    """
-    """
-    external_stylesheets = [
-        BOOTSTRAP,
-        'https://fonts.googleapis.com/css2?family=Open+Sans:ital,wght@0,400;0,600;1,400;1,600&display=swap',
-    ]
-
-    def __init__(self, language, defaults):
-        """
-        """
-        super().__init__(language, defaults)
-        self.components = OrderedDict(
-            navbar=Navbar(language, defaults),
-            sidebar=Sidebar(language, defaults),
-            # todo subscribe to changes to URL and select page appropriately
-            index=Index(language, defaults),
-        )
-
-    def get_html(self):
-        """Glues individual setup components together
-        """
-        return Div(
-            className="app",
-            children=self.components["navbar"].html + [
-                Div(
-                    className="app-content",
-                    children=
-                    self.components["sidebar"].html
-                    + self.components["index"].html
-                )
-            ]
-        )
-
-    def get_html_old(self):
-        """Glues individual setup components together
-        """
-        return Div(children=
-                   self.components["navbar"].html
-                   + [Container(
-                       children=Row(self.components["sidebar"].html + [Div(
-                           id="page-wrapper",
-                           children=self.components["index"].html
-                       )]),
-                       fluid=True,
-                       className="mt-5",
-                   )])
+modules         desc.       route
+----            ----        ----
+index           homepage    /
+"""

src/chime_dash/app/components/base.py

@@ -4,19 +4,17 @@
 
 #! candidate for moving into utils/components
 """
-from typing import List, Dict, Any, Union
+from typing import List, Dict, Union
 
 from abc import ABC
 
-from dash import Dash
 from dash.development.base_component import ComponentMeta
 from dash_html_components import Div
 
 from penn_chime.parameters import Parameters
 from penn_chime.settings import get_defaults
 
 from chime_dash.app.utils.templates import read_localization_yml, read_localization_markdown
-from chime_dash.app.utils.callbacks import ChimeCallback, register_callbacks
 
 DEFAULTS = get_defaults()
 
@@ -34,19 +32,13 @@ class Component(ABC):
     external_stylesheets: List[str] = []
     external_scripts: List[str] = []
 
-    def __init__(
-            self,
-            language: str = "en",
-            defaults: Parameters = DEFAULTS,
-            callbacks: List[ChimeCallback] = None
-    ):
+    def __init__(self, language: str = "en", defaults: Parameters = DEFAULTS):
         """Initializes the component
         """
         self.language = language
         self.defaults = defaults
         self._content = None
         self._html = None
-        register_callbacks(callbacks)
 
     def get_html(self) -> List[ComponentMeta]:  # pylint: disable=R0201
         """Function which is called to render html elements.
@@ -99,6 +91,14 @@ def content(self) -> Union[str, Dict[str, str], None]:
         return self._content
 
 
+class Page(Component):
+    callbacks_cls = None
+
+    def __init__(self, language: str = "en", defaults: Parameters = DEFAULTS):
+        super().__init__(language, defaults)
+        self.callbacks_cls(self)
+
+
 class HTMLComponentError(Exception):
     """Custom exception for errors when rendering component html.
 

src/chime_dash/app/pages/index.py

@@ -1,88 +1,28 @@
 """pages/index
 Homepage
 """
-
 from collections import OrderedDict
 
 from dash_html_components import Main
 from dash_bootstrap_components import Container
 
-from chime_dash.app.components.base import Component
+from chime_dash.app.components.base import Page
 from chime_dash.app.components.footer import Footer
 from chime_dash.app.components.header import Header
 from chime_dash.app.components.intro import Intro
 from chime_dash.app.components.visualizations import Visualizations
+from chime_dash.app.services.callbacks import IndexCallbacks
 
-from chime_dash.app.utils import get_n_switch_values, parameters_deserializer, prepare_visualization_group
-from chime_dash.app.utils.callbacks import ChimeCallback
-
-from penn_chime.models import SimSirModel
 
-
-class Index(Component):
+class Index(Page):
     """
     """
-
-    @staticmethod
-    def toggle_tool_details(switch_value):
-        return get_n_switch_values(switch_value, 1)
-
-    @staticmethod
-    def toggle_tables(switch_value):
-        return get_n_switch_values(switch_value, 3)
+    callbacks_cls = IndexCallbacks
 
     def __init__(self, language, defaults):
         """
         """
-
-        def handle_model_change_helper(pars_json):
-            model = {}
-            pars = None
-            result = []
-            viz_kwargs = {}
-            if pars_json:
-                pars = parameters_deserializer(pars_json)
-                model = SimSirModel(pars)
-                viz_kwargs = dict(
-                    labels=pars.labels,
-                    table_mod=7,
-                    max_y_axis=pars.max_y_axis,
-                )
-            result.extend(self.components["intro"].build(model, pars))
-            for df_key in ["admits_df", "census_df", "sim_sir_w_date_df"]:
-                df = None
-                if model:
-                    df = model.__dict__.get(df_key, None)
-                result.extend(prepare_visualization_group(df, **viz_kwargs))
-            return result
-
-        super().__init__(language, defaults, [
-            ChimeCallback(  # If user toggles show_tables, show/hide tables
-                changed_elements=OrderedDict(show_tables="value"),
-                dom_updates=OrderedDict(
-                    SIR_table_container="hidden",
-                    new_admissions_table_container="hidden",
-                    admitted_patients_table_container="hidden",
-                ),
-                callback_fn=Index.toggle_tables
-            ),
-            ChimeCallback(  # If the parameters or model change, update the text
-                changed_elements=OrderedDict(pars="children"),
-                dom_updates=OrderedDict(
-                    intro="children",
-                    new_admissions_graph="figure",
-                    new_admissions_table="children",
-                    new_admissions_download="href",
-                    admitted_patients_graph="figure",
-                    admitted_patients_table="children",
-                    admitted_patients_download="href",
-                    SIR_graph="figure",
-                    SIR_table="children",
-                    SIR_download="href",
-                ),
-                callback_fn=handle_model_change_helper
-            )
-        ])
+        super().__init__()
         self.components = OrderedDict(
             header=Header(language, defaults),
             intro=Intro(language, defaults),
@@ -99,16 +39,13 @@ def get_html(self):
                 "marginLeft": "320px",
                 "marginTop": "56px"
             },
-            children=
-            [Container(
-                children=
-                self.components["header"].html
+            children=[Container(
+                children=self.components["header"].html
                 + self.components["intro"].html
             )]
             + self.components["visualizations"].html
             + [Container(
-                children=
-                self.components["footer"].html
+                children=self.components["footer"].html
             )],
         )
 

src/chime_dash/app/pages/root.py

@@ -0,0 +1,56 @@
+"""Combines all components
+
+The `sidebar` component combines all the inputs while other components potentially
+have callbacks.
+
+To add or remove components, adjust the `setup`.
+"""
+from collections import OrderedDict
+
+from dash_bootstrap_components.themes import BOOTSTRAP
+from dash_html_components import Div
+from dash_core_components import Location, Store
+
+from chime_dash.app.components.base import Page
+from chime_dash.app.components.navbar import Navbar
+from chime_dash.app.pages.index import Index
+from chime_dash.app.pages.sidebar import Sidebar
+from chime_dash.app.utils import singleton
+from chime_dash.app.services.callbacks import RootCallbacks
+
+@singleton
+class Root(Page):
+    """
+    """
+    external_stylesheets = [
+        BOOTSTRAP,
+        'https://fonts.googleapis.com/css2?family=Open+Sans:ital,wght@0,400;0,600;1,400;1,600&display=swap',
+    ]
+    callbacks_cls = RootCallbacks
+
+    def __init__(self, language, defaults):
+        """
+        """
+        self.components = OrderedDict(
+            navbar=Navbar(language, defaults),
+            sidebar=Sidebar(language, defaults),
+            # todo subscribe to changes to URL and select page appropriately
+            index=Index(language, defaults),
+        )
+        super().__init__(language, defaults)
+
+    def get_html(self):
+        """Glues individual setup components together
+        """
+        return Div(
+            className="app",
+            children=self.components["navbar"].html + [
+                Div(
+                    className="app-content",
+                    children=self.components["sidebar"].html
+                             + self.components["index"].html
+                ),
+                Store(id="root-store"),
+                Location(id='location')
+            ]
+        )