from dash import html
from dash import callback_context, no_update, ALL
from dash import Input, Output, State
+from dash.exceptions import PreventUpdate
from yaml import load, FullLoader, YAMLError
from copy import deepcopy
from ast import literal_eval
from ..utils.constants import Constants as C
-from ..utils.url_processing import url_decode, url_encode
+from ..utils.utils import show_tooltip, label, sync_checklists, list_tests, \
+ gen_new_url, generate_options
+from ..utils.url_processing import url_decode
from ..data.data import Data
-from .graphs import graph_iterative, table_comparison, get_short_version
+from .graphs import graph_iterative, table_comparison, get_short_version, \
+ select_iterative_data
class Layout:
- """
+ """The layout of the dash app and the callbacks.
"""
def __init__(self, app: Flask, releases: list, html_layout_file: str,
graph_layout_file: str, data_spec_file: str, tooltip_file: str) -> None:
- """
+ """Initialization:
+ - save the input parameters,
+ - read and pre-process the data,
+ - prepare data for the control panel,
+ - read HTML layout file,
+ - read tooltips from the tooltip file.
+
+ :param app: Flask application running the dash application.
+ :param releases: Lis of releases to be displayed.
+ :param html_layout_file: Path and name of the file specifying the HTML
+ layout of the dash application.
+ :param graph_layout_file: Path and name of the file with layout of
+ plot.ly graphs.
+ :param data_spec_file: Path and name of the file specifying the data to
+ be read from parquets for this application.
+ :param tooltip_file: Path and name of the yaml file specifying the
+ tooltips.
+ :type app: Flask
+ :type releases: list
+ :type html_layout_file: str
+ :type graph_layout_file: str
+ :type data_spec_file: str
+ :type tooltip_file: str
"""
# Inputs
def layout(self):
return self._graph_layout
- def label(self, key: str) -> str:
- return C.LABELS.get(key, key)
+ def add_content(self):
+ """Top level method which generated the web page.
- def _show_tooltip(self, id: str, title: str,
- clipboard_id: str=None) -> list:
- """
- """
- return [
- dcc.Clipboard(target_id=clipboard_id, title="Copy URL") \
- if clipboard_id else str(),
- f"{title} ",
- dbc.Badge(
- id=id,
- children="?",
- pill=True,
- color="white",
- text_color="info",
- class_name="border ms-1",
- ),
- dbc.Tooltip(
- children=self._tooltips.get(id, str()),
- target=id,
- placement="auto"
- )
- ]
+ It generates:
+ - Store for user input data,
+ - Navigation bar,
+ - Main area with control panel and ploting area.
- def add_content(self):
- """
+ If no HTML layout is provided, an error message is displayed instead.
+
+ :returns: The HTML div with the whole page.
+ :rtype: html.Div
"""
+
if self.html_layout and self.spec_tbs:
return html.Div(
id="div-main",
def _add_navbar(self):
"""Add nav element with navigation panel. It is placed on the top.
+
+ :returns: Navigation bar.
+ :rtype: dbc.NavbarSimple
"""
return dbc.NavbarSimple(
id="navbarsimple-main",
def _add_ctrl_col(self) -> dbc.Col:
"""Add column with controls. It is placed on the left side.
+
+ :returns: Column with the control panel.
+ :rtype: dbc.Col
"""
return dbc.Col(
id="col-controls",
def _add_plotting_col(self) -> dbc.Col:
"""Add column with plots and tables. It is placed on the right side.
+
+ :returns: Column with tables.
+ :rtype: dbc.Col
"""
return dbc.Col(
id="col-plotting-area",
)
def _add_ctrl_panel(self) -> dbc.Row:
- """
+ """Add control panel.
+
+ :returns: Control panel.
+ :rtype: dbc.Row
"""
return dbc.Row(
id="row-ctrl-panel",
dbc.InputGroup(
[
dbc.InputGroupText(
- children=self._show_tooltip(
+ children=show_tooltip(self._tooltips,
"help-release", "CSIT Release")
),
dbc.Select(
dbc.InputGroup(
[
dbc.InputGroupText(
- children=self._show_tooltip(
+ children=show_tooltip(self._tooltips,
"help-dut", "DUT")
),
dbc.Select(
dbc.InputGroup(
[
dbc.InputGroupText(
- children=self._show_tooltip(
+ children=show_tooltip(self._tooltips,
"help-dut-ver", "DUT Version")
),
dbc.Select(
dbc.InputGroup(
[
dbc.InputGroupText(
- children=self._show_tooltip(
+ children=show_tooltip(self._tooltips,
"help-infra", "Infra")
),
dbc.Select(
dbc.InputGroup(
[
dbc.InputGroupText(
- children=self._show_tooltip(
+ children=show_tooltip(self._tooltips,
"help-area", "Area")
),
dbc.Select(
dbc.InputGroup(
[
dbc.InputGroupText(
- children=self._show_tooltip(
+ children=show_tooltip(self._tooltips,
"help-test", "Test")
),
dbc.Select(
class_name="gy-1",
children=[
dbc.Label(
- children=self._show_tooltip(
+ children=show_tooltip(self._tooltips,
"help-framesize", "Frame Size"),
class_name="p-0"
),
class_name="gy-1",
children=[
dbc.Label(
- children=self._show_tooltip(
+ children=show_tooltip(self._tooltips,
"help-cores", "Number of Cores"),
class_name="p-0"
),
class_name="gy-1",
children=[
dbc.Label(
- children=self._show_tooltip(
+ children=show_tooltip(self._tooltips,
"help-ttype", "Test Type"),
class_name="p-0"
),
class_name="gy-1",
children=[
dbc.Label(
- children=self._show_tooltip(
+ children=show_tooltip(self._tooltips,
"help-normalize", "Normalize"),
class_name="p-0"
),
)
class ControlPanel:
+ """A class representing the control panel.
+ """
+
def __init__(self, panel: dict) -> None:
+ """Initialisation of the control pannel by default values. If
+ particular values are provided (parameter "panel") they are set
+ afterwards.
+
+ :param panel: Custom values to be set to the control panel.
+ :param default: Default values to be set to the control panel.
+ :type panel: dict
+ :type defaults: dict
+ """
# Defines also the order of keys
self._defaults = {
return self._panel
def set(self, kwargs: dict) -> None:
+ """Set the values of the Control panel.
+
+ :param kwargs: key - value pairs to be set.
+ :type kwargs: dict
+ :raises KeyError: If the key in kwargs is not present in the Control
+ panel.
+ """
for key, val in kwargs.items():
if key in self._panel:
self._panel[key] = val
raise KeyError(f"The key {key} is not defined.")
def get(self, key: str) -> any:
+ """Returns the value of a key from the Control panel.
+
+ :param key: The key which value should be returned.
+ :type key: str
+ :returns: The value of the key.
+ :rtype: any
+ :raises KeyError: If the key in kwargs is not present in the Control
+ panel.
+ """
return self._panel[key]
def values(self) -> tuple:
+ """Returns the values from the Control panel as a list.
+
+ :returns: The values from the Control panel.
+ :rtype: list
+ """
return tuple(self._panel.values())
- @staticmethod
- def _sync_checklists(opt: list, sel: list, all: list, id: str) -> tuple:
- """
- """
- options = {v["value"] for v in opt}
- if id =="all":
- sel = list(options) if all else list()
- else:
- all = ["all", ] if set(sel) == options else list()
- return sel, all
+ def callbacks(self, app):
+ """Callbacks for the whole application.
- @staticmethod
- def _list_tests(selection: dict) -> list:
- """Display selected tests with checkboxes
+ :param app: The application.
+ :type app: Flask
"""
- if selection:
- return [{"label": v["id"], "value": v["id"]} for v in selection]
- else:
- return list()
-
- def callbacks(self, app):
def _generate_plotting_area(figs: tuple, table: pd.DataFrame,
url: str) -> tuple:
- """
+ """Generate the plotting area with all its content.
+
+ :param figs: Figures to be placed in the plotting area.
+ :param table: A table to be placed in the plotting area bellow the
+ figures.
+ :param utl: The URL to be placed in the plotting area bellow the
+ tables.
+ :type figs: tuple of plotly.graph_objects.Figure
+ :type table: pandas.DataFrame
+ :type url: str
+ :returns: tuple of elements to be shown in the plotting area.
+ :rtype: tuple
+ (dcc.Graph, dcc.Graph, dbc.Table, list(dbc.Col, dbc.Col))
"""
(fig_tput, fig_lat) = figs
dcc.Loading(children=[
dbc.Button(
id="btn-download-data",
- children=self._show_tooltip(
+ children=show_tooltip(self._tooltips,
"help-download", "Download Data"),
class_name="me-1",
color="info"
children=[
dbc.InputGroupText(
style=C.URL_STYLE,
- children=self._show_tooltip(
+ children=show_tooltip(self._tooltips,
"help-url", "URL", "input-url")
),
dbc.Input(
cl_framesize_all: list, cl_testtype: list, cl_testtype_all: list,
cl_normalize: list, btn_add: int, btn_remove: int,
btn_remove_all: int, href: str) -> tuple:
- """
- """
-
- def _gen_new_url(parsed_url: dict, store_sel: list) -> str:
+ """Update the application when the event is detected.
- if parsed_url:
- new_url = url_encode({
- "scheme": parsed_url["scheme"],
- "netloc": parsed_url["netloc"],
- "path": parsed_url["path"],
- "params": {
- "store_sel": store_sel,
- }
- })
- else:
- new_url = str()
- return new_url
+ :param cp_data: Current status of the control panel stored in
+ browser.
+ :param store_sel: List of tests selected by user stored in the
+ browser.
+ :param list_sel: List of tests selected by the user shown in the
+ checklist.
+ :param dd_rls: Input - Releases.
+ :param dd_dut: Input - DUTs.
+ :param dd_dutver: Input - Version of DUT.
+ :param dd_phy: Input - topo- arch-nic-driver.
+ :param dd_area: Input - Tested area.
+ :param dd_test: Input - Test.
+ :param cl_core: Input - Number of cores.
+ :param cl_core_all: Input - All numbers of cores.
+ :param cl_framesize: Input - Frame sizes.
+ :param cl_framesize_all: Input - All frame sizes.
+ :param cl_testtype: Input - Test type (NDR, PDR, MRR).
+ :param cl_testtype_all: Input - All test types.
+ :param cl_normalize: Input - Normalize the results.
+ :param btn_add: Input - Button "Add Selected" tests.
+ :param btn_remove: Input - Button "Remove selected" tests.
+ :param btn_remove_all: Input - Button "Remove All" tests.
+ :param href: Input - The URL provided by the browser.
+ :type cp_data: dict
+ :type store_sel: list
+ :type list_sel: list
+ :type dd_rls: str
+ :type dd_dut: str
+ :type dd_dutver: str
+ :type dd_phy: str
+ :type dd_area: str
+ :type dd_test: str
+ :type cl_core: list
+ :type cl_core_all: list
+ :type cl_framesize: list
+ :type cl_framesize_all: list
+ :type cl_testtype: list
+ :type cl_testtype_all: list
+ :type cl_normalize: list
+ :type btn_add: int
+ :type btn_remove: int
+ :type btn_remove_all: int
+ :type href: str
+ :returns: New values for web page elements.
+ :rtype: tuple
+ """
ctrl_panel = self.ControlPanel(cp_data)
+ norm = cl_normalize
# Parse the url:
parsed_url = url_decode(href)
+ if parsed_url:
+ url_params = parsed_url["params"]
+ else:
+ url_params = None
row_fig_tput = no_update
row_fig_lat = no_update
if trigger_id == "dd-ctrl-rls":
try:
- rls = self.spec_tbs[dd_rls]
- options = sorted(
- [{"label": v, "value": v} for v in rls.keys()],
- key=lambda d: d["label"]
- )
+ options = \
+ generate_options(sorted(self.spec_tbs[dd_rls].keys()))
disabled = False
except KeyError:
options = list()
try:
rls = ctrl_panel.get("dd-rls-value")
dut = self.spec_tbs[rls][dd_dut]
- options = sorted(
- [{"label": v, "value": v} for v in dut.keys()],
- key=lambda d: d["label"]
- )
+ options = generate_options(sorted(dut.keys()))
disabled = False
except KeyError:
options = list()
rls = ctrl_panel.get("dd-rls-value")
dut = ctrl_panel.get("dd-dut-value")
dutver = self.spec_tbs[rls][dut][dd_dutver]
- options = sorted(
- [{"label": v, "value": v} for v in dutver.keys()],
- key=lambda d: d["label"]
- )
+ options = generate_options(sorted(dutver.keys()))
disabled = False
except KeyError:
options = list()
dut = ctrl_panel.get("dd-dut-value")
dutver = ctrl_panel.get("dd-dutver-value")
phy = self.spec_tbs[rls][dut][dutver][dd_phy]
- options = sorted(
- [{"label": self.label(v), "value": v}
- for v in phy.keys()],
- key=lambda d: d["label"]
- )
+ options = [{"label": label(v), "value": v} \
+ for v in sorted(phy.keys())]
disabled = False
except KeyError:
options = list()
dutver = ctrl_panel.get("dd-dutver-value")
phy = ctrl_panel.get("dd-phy-value")
area = self.spec_tbs[rls][dut][dutver][phy][dd_area]
- options = sorted(
- [{"label": v, "value": v} for v in area.keys()],
- key=lambda d: d["label"]
- )
+ options = generate_options(sorted(area.keys()))
disabled = False
except KeyError:
options = list()
dutver = ctrl_panel.get("dd-dutver-value")
phy = ctrl_panel.get("dd-phy-value")
area = ctrl_panel.get("dd-area-value")
- test = self.spec_tbs[rls][dut][dutver][phy][area][dd_test]
- if dut and phy and area and dd_test:
+ if all((rls, dut, dutver, phy, area, dd_test, )):
+ test = self.spec_tbs[rls][dut][dutver][phy][area][dd_test]
ctrl_panel.set({
"dd-test-value": dd_test,
- "cl-core-options": [{"label": v, "value": v}
- for v in sorted(test["core"])],
+ "cl-core-options": \
+ generate_options(sorted(test["core"])),
"cl-core-value": list(),
"cl-core-all-value": list(),
"cl-core-all-options": C.CL_ALL_ENABLED,
- "cl-framesize-options": [{"label": v, "value": v}
- for v in sorted(test["frame-size"])],
+ "cl-framesize-options": \
+ generate_options(sorted(test["frame-size"])),
"cl-framesize-value": list(),
"cl-framesize-all-value": list(),
"cl-framesize-all-options": C.CL_ALL_ENABLED,
- "cl-testtype-options": [{"label": v, "value": v}
- for v in sorted(test["test-type"])],
+ "cl-testtype-options": \
+ generate_options(sorted(test["test-type"])),
"cl-testtype-value": list(),
"cl-testtype-all-value": list(),
"cl-testtype-all-options": C.CL_ALL_ENABLED,
})
elif trigger_id == "cl-ctrl-core":
- val_sel, val_all = self._sync_checklists(
- opt=ctrl_panel.get("cl-core-options"),
+ val_sel, val_all = sync_checklists(
+ options=ctrl_panel.get("cl-core-options"),
sel=cl_core,
all=list(),
id=""
"cl-core-all-value": val_all,
})
elif trigger_id == "cl-ctrl-core-all":
- val_sel, val_all = self._sync_checklists(
- opt = ctrl_panel.get("cl-core-options"),
+ val_sel, val_all = sync_checklists(
+ options = ctrl_panel.get("cl-core-options"),
sel=list(),
all=cl_core_all,
id="all"
"cl-core-all-value": val_all,
})
elif trigger_id == "cl-ctrl-framesize":
- val_sel, val_all = self._sync_checklists(
- opt = ctrl_panel.get("cl-framesize-options"),
+ val_sel, val_all = sync_checklists(
+ options = ctrl_panel.get("cl-framesize-options"),
sel=cl_framesize,
all=list(),
id=""
"cl-framesize-all-value": val_all,
})
elif trigger_id == "cl-ctrl-framesize-all":
- val_sel, val_all = self._sync_checklists(
- opt = ctrl_panel.get("cl-framesize-options"),
+ val_sel, val_all = sync_checklists(
+ options = ctrl_panel.get("cl-framesize-options"),
sel=list(),
all=cl_framesize_all,
id="all"
"cl-framesize-all-value": val_all,
})
elif trigger_id == "cl-ctrl-testtype":
- val_sel, val_all = self._sync_checklists(
- opt = ctrl_panel.get("cl-testtype-options"),
+ val_sel, val_all = sync_checklists(
+ options = ctrl_panel.get("cl-testtype-options"),
sel=cl_testtype,
all=list(),
id=""
"cl-testtype-all-value": val_all,
})
elif trigger_id == "cl-ctrl-testtype-all":
- val_sel, val_all = self._sync_checklists(
- opt = ctrl_panel.get("cl-testtype-options"),
+ val_sel, val_all = sync_checklists(
+ options = ctrl_panel.get("cl-testtype-options"),
sel=list(),
all=cl_testtype_all,
id="all"
if C.CLEAR_ALL_INPUTS:
ctrl_panel.set(ctrl_panel.defaults)
ctrl_panel.set({
- "cl-selected-options": self._list_tests(store_sel)
+ "cl-selected-options": list_tests(store_sel)
})
elif trigger_id == "btn-sel-remove-all":
_ = btn_remove_all
new_store_sel.append(item)
store_sel = new_store_sel
elif trigger_id == "url":
- # TODO: Add verification
- url_params = parsed_url["params"]
if url_params:
- store_sel = literal_eval(
- url_params.get("store_sel", list())[0])
+ try:
+ store_sel = literal_eval(url_params["store_sel"][0])
+ norm = literal_eval(url_params["norm"][0])
+ except (KeyError, IndexError):
+ pass
if store_sel:
row_card_sel_tests = C.STYLE_ENABLED
row_btns_sel_tests = C.STYLE_ENABLED
+ last_test = store_sel[-1]
+ test = self.spec_tbs[last_test["rls"]]\
+ [last_test["dut"]][last_test["dutver"]]\
+ [last_test["phy"]][last_test["area"]]\
+ [last_test["test"]]
+ ctrl_panel.set({
+ "dd-rls-value": last_test["rls"],
+ "dd-dut-value": last_test["dut"],
+ "dd-dut-options": generate_options(sorted(
+ self.spec_tbs[last_test["rls"]].keys())),
+ "dd-dut-disabled": False,
+ "dd-dutver-value": last_test["dutver"],
+ "dd-dutver-options": generate_options(sorted(
+ self.spec_tbs[last_test["rls"]]\
+ [last_test["dut"]].keys())),
+ "dd-dutver-disabled": False,
+ "dd-phy-value": last_test["phy"],
+ "dd-phy-options": generate_options(sorted(
+ self.spec_tbs[last_test["rls"]]\
+ [last_test["dut"]]\
+ [last_test["dutver"]].keys())),
+ "dd-phy-disabled": False,
+ "dd-area-value": last_test["area"],
+ "dd-area-options": [
+ {"label": label(v), "value": v} for v in \
+ sorted(self.spec_tbs[last_test["rls"]]\
+ [last_test["dut"]][last_test["dutver"]]\
+ [last_test["phy"]].keys())
+ ],
+ "dd-area-disabled": False,
+ "dd-test-value": last_test["test"],
+ "dd-test-options": generate_options(sorted(
+ self.spec_tbs[last_test["rls"]]\
+ [last_test["dut"]][last_test["dutver"]]\
+ [last_test["phy"]]\
+ [last_test["area"]].keys())),
+ "dd-test-disabled": False,
+ "cl-core-options": generate_options(sorted(
+ test["core"])),
+ "cl-core-value": [last_test["core"].upper(), ],
+ "cl-core-all-value": list(),
+ "cl-core-all-options": C.CL_ALL_ENABLED,
+ "cl-framesize-options": generate_options(
+ sorted(test["frame-size"])),
+ "cl-framesize-value": \
+ [last_test["framesize"].upper(), ],
+ "cl-framesize-all-value": list(),
+ "cl-framesize-all-options": C.CL_ALL_ENABLED,
+ "cl-testtype-options": generate_options(sorted(
+ test["test-type"])),
+ "cl-testtype-value": \
+ [last_test["testtype"].upper(), ],
+ "cl-testtype-all-value": list(),
+ "cl-testtype-all-options": C.CL_ALL_ENABLED
+ })
if trigger_id in ("btn-ctrl-add", "url", "btn-sel-remove",
"cl-ctrl-normalize"):
row_fig_tput, row_fig_lat, row_table, row_btn_dwnld = \
_generate_plotting_area(
graph_iterative(
- self.data, store_sel, self.layout,
- bool(cl_normalize)
+ self.data, store_sel, self.layout, bool(norm)
),
table_comparison(
- self.data, store_sel, bool(cl_normalize)
+ self.data, store_sel, bool(norm)
),
- _gen_new_url(parsed_url, store_sel)
+ gen_new_url(
+ parsed_url,
+ {"store_sel": store_sel, "norm": norm}
+ )
)
ctrl_panel.set({
- "cl-selected-options": self._list_tests(store_sel)
+ "cl-selected-options": list_tests(store_sel)
})
else:
row_fig_tput = C.PLACEHOLDER
disabled = True
ctrl_panel.set({
"btn-add-disabled": disabled,
- "cl-normalize-value": cl_normalize
+ "cl-normalize-value": norm
})
ret_val = [
ret_val.extend(ctrl_panel.values())
return ret_val
- # @app.callback(
- # Output("download-data", "data"),
- # State("selected-tests", "data"),
- # Input("btn-download-data", "n_clicks"),
- # prevent_initial_call=True
- # )
- # def _download_data(store_sel, n_clicks):
- # """
- # """
-
- # if not n_clicks:
- # raise PreventUpdate
-
- # if not store_sel:
- # raise PreventUpdate
-
- # df = pd.DataFrame()
- # for itm in store_sel:
- # sel_data = select_trending_data(self.data, itm)
- # if sel_data is None:
- # continue
- # df = pd.concat([df, sel_data], ignore_index=True)
-
- # return dcc.send_data_frame(df.to_csv, "trending_data.csv")
+ @app.callback(
+ Output("download-data", "data"),
+ State("selected-tests", "data"),
+ Input("btn-download-data", "n_clicks"),
+ prevent_initial_call=True
+ )
+ def _download_data(store_sel, n_clicks):
+ """Download the data
+
+ :param store_sel: List of tests selected by user stored in the
+ browser.
+ :param n_clicks: Number of clicks on the button "Download".
+ :type store_sel: list
+ :type n_clicks: int
+ :returns: dict of data frame content (base64 encoded) and meta data
+ used by the Download component.
+ :rtype: dict
+ """
+
+ if not n_clicks:
+ raise PreventUpdate
+
+ if not store_sel:
+ raise PreventUpdate
+
+ df = pd.DataFrame()
+ for itm in store_sel:
+ sel_data = select_iterative_data(self.data, itm)
+ if sel_data is None:
+ continue
+ df = pd.concat([df, sel_data], ignore_index=True)
+
+ return dcc.send_data_frame(df.to_csv, C.REPORT_DOWNLOAD_FILE_NAME)
Code Review / csit.git / blobdiff