X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Ftools%2Fdash%2Fapp%2Fpal%2Ftrending%2Flayout.py;h=2be19f8439f5e9d0de4be9a96af49ae4e28528f4;hp=6d9eca66f82bd57e6cb27fcfed26dea35e8662eb;hb=808797d2d913eac7581a4e4cba3fb826ddbff775;hpb=c3ce5119c09eb40607a4b82f242c10ff2c56284a diff --git a/resources/tools/dash/app/pal/trending/layout.py b/resources/tools/dash/app/pal/trending/layout.py index 6d9eca66f8..2be19f8439 100644 --- a/resources/tools/dash/app/pal/trending/layout.py +++ b/resources/tools/dash/app/pal/trending/layout.py @@ -30,67 +30,51 @@ from copy import deepcopy from json import loads, JSONDecodeError from ast import literal_eval +from ..utils.constants import Constants as C +from ..utils.utils import show_tooltip, label, sync_checklists, list_tests, \ + get_date, gen_new_url +from ..utils.url_processing import url_decode from ..data.data import Data from .graphs import graph_trending, graph_hdrh_latency, \ select_trending_data -from ..data.url_processing import url_decode, url_encode class Layout: - """ + """The layout of the dash app and the callbacks. """ - STYLE_DISABLED = {"display": "none"} - STYLE_ENABLED = {"display": "inherit"} - - CL_ALL_DISABLED = [{ - "label": "All", - "value": "all", - "disabled": True - }] - CL_ALL_ENABLED = [{ - "label": "All", - "value": "all", - "disabled": False - }] - - PLACEHOLDER = html.Nobr("") - - DRIVERS = ("avf", "af-xdp", "rdma", "dpdk") - - LABELS = { - "dpdk": "DPDK", - "container_memif": "LXC/DRC Container Memif", - "crypto": "IPSec IPv4 Routing", - "ip4": "IPv4 Routing", - "ip6": "IPv6 Routing", - "ip4_tunnels": "IPv4 Tunnels", - "l2": "L2 Ethernet Switching", - "srv6": "SRv6 Routing", - "vm_vhost": "VMs vhost-user", - "nfv_density-dcr_memif-chain_ipsec": "CNF Service Chains Routing IPSec", - "nfv_density-vm_vhost-chain_dot1qip4vxlan":"VNF Service Chains Tunnels", - "nfv_density-vm_vhost-chain": "VNF Service Chains Routing", - "nfv_density-dcr_memif-pipeline": "CNF Service Pipelines Routing", - "nfv_density-dcr_memif-chain": "CNF Service Chains Routing", - } - - URL_STYLE = { - "background-color": "#d2ebf5", - "border-color": "#bce1f1", - "color": "#135d7c" - } - - def __init__(self, app: Flask, html_layout_file: str, spec_file: str, + def __init__(self, app: Flask, html_layout_file: str, graph_layout_file: str, data_spec_file: str, tooltip_file: str, time_period: str=None) -> 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 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. + :param time_period: It defines the time period for data read from the + parquets in days from now back to the past. + :type app: Flask + :type html_layout_file: str + :type graph_layout_file: str + :type data_spec_file: str + :type tooltip_file: str + :type time_period: int """ # Inputs self._app = app self._html_layout_file = html_layout_file - self._spec_file = spec_file self._graph_layout_file = graph_layout_file self._data_spec_file = data_spec_file self._tooltip_file = tooltip_file @@ -132,7 +116,7 @@ class Layout: replace("2n-", "") test = lst_test[-1] nic = suite.split("-")[0] - for drv in self.DRIVERS: + for drv in C.DRIVERS: if drv in test: if drv == "af-xdp": driver = "af_xdp" @@ -238,35 +222,20 @@ class Layout: def time_period(self): return self._time_period - def label(self, key: str) -> str: - return self.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", @@ -319,6 +288,9 @@ class Layout: 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", @@ -341,6 +313,9 @@ class Layout: 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", @@ -351,6 +326,9 @@ class Layout: 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", @@ -361,21 +339,21 @@ class Layout: id="row-graph-tput", class_name="g-0 p-2", children=[ - self.PLACEHOLDER + C.PLACEHOLDER ] ), dbc.Row( # Latency id="row-graph-lat", class_name="g-0 p-2", children=[ - self.PLACEHOLDER + C.PLACEHOLDER ] ), dbc.Row( # Download id="row-btn-download", class_name="g-0 p-2", children=[ - self.PLACEHOLDER + C.PLACEHOLDER ] ) ] @@ -385,7 +363,10 @@ class Layout: ) def _add_ctrl_panel(self) -> dbc.Row: - """ + """Add control panel. + + :returns: Control panel. + :rtype: dbc.Row """ return dbc.Row( id="row-ctrl-panel", @@ -397,7 +378,7 @@ class Layout: dbc.InputGroup( [ dbc.InputGroupText( - children=self._show_tooltip( + children=show_tooltip(self._tooltips, "help-dut", "DUT") ), dbc.Select( @@ -425,7 +406,7 @@ class Layout: dbc.InputGroup( [ dbc.InputGroupText( - children=self._show_tooltip( + children=show_tooltip(self._tooltips, "help-infra", "Infra") ), dbc.Select( @@ -447,7 +428,7 @@ class Layout: dbc.InputGroup( [ dbc.InputGroupText( - children=self._show_tooltip( + children=show_tooltip(self._tooltips, "help-area", "Area") ), dbc.Select( @@ -467,7 +448,7 @@ class Layout: dbc.InputGroup( [ dbc.InputGroupText( - children=self._show_tooltip( + children=show_tooltip(self._tooltips, "help-test", "Test") ), dbc.Select( @@ -486,7 +467,7 @@ class Layout: class_name="gy-1", children=[ dbc.Label( - children=self._show_tooltip( + children=show_tooltip(self._tooltips, "help-framesize", "Frame Size"), class_name="p-0" ), @@ -494,7 +475,7 @@ class Layout: children=[ dbc.Checklist( id="cl-ctrl-framesize-all", - options=self.CL_ALL_DISABLED, + options=C.CL_ALL_DISABLED, inline=True, switch=False ), @@ -517,7 +498,7 @@ class Layout: 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" ), @@ -525,7 +506,7 @@ class Layout: children=[ dbc.Checklist( id="cl-ctrl-core-all", - options=self.CL_ALL_DISABLED, + options=C.CL_ALL_DISABLED, inline=False, switch=False ) @@ -548,7 +529,7 @@ class Layout: class_name="gy-1", children=[ dbc.Label( - children=self._show_tooltip( + children=show_tooltip(self._tooltips, "help-ttype", "Test Type"), class_name="p-0" ), @@ -556,7 +537,7 @@ class Layout: children=[ dbc.Checklist( id="cl-ctrl-testtype-all", - options=self.CL_ALL_DISABLED, + options=C.CL_ALL_DISABLED, inline=True, switch=False ), @@ -574,6 +555,34 @@ class Layout: ) ] ), + dbc.Row( + id="row-ctrl-normalize", + class_name="gy-1", + children=[ + dbc.Label( + children=show_tooltip(self._tooltips, + "help-normalize", "Normalize"), + class_name="p-0" + ), + dbc.Col( + children=[ + dbc.Checklist( + id="cl-ctrl-normalize", + options=[{ + "value": "normalize", + "label": ( + "Normalize results to CPU" + "frequency 2GHz" + ) + }], + value=[], + inline=True, + switch=False + ), + ] + ) + ] + ), dbc.Row( class_name="gy-1 p-0", children=[ @@ -595,7 +604,7 @@ class Layout: children=[ dbc.Label( class_name="gy-1", - children=self._show_tooltip( + children=show_tooltip(self._tooltips, "help-time-period", "Time Period"), ), dcc.DatePickerRange( @@ -617,7 +626,7 @@ class Layout: dbc.Row( id="row-card-sel-tests", class_name="gy-1", - style=self.STYLE_DISABLED, + style=C.STYLE_DISABLED, children=[ dbc.Label( "Selected tests", @@ -634,7 +643,7 @@ class Layout: ), dbc.Row( id="row-btns-sel-tests", - style=self.STYLE_DISABLED, + style=C.STYLE_DISABLED, children=[ dbc.ButtonGroup( class_name="gy-2", @@ -662,13 +671,19 @@ class Layout: ) class ControlPanel: - def __init__(self, panel: dict) -> None: + """A class representing the control panel. + """ - CL_ALL_DISABLED = [{ - "label": "All", - "value": "all", - "disabled": True - }] + 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 = { @@ -685,16 +700,17 @@ class Layout: "cl-ctrl-core-options": list(), "cl-ctrl-core-value": list(), "cl-ctrl-core-all-value": list(), - "cl-ctrl-core-all-options": CL_ALL_DISABLED, + "cl-ctrl-core-all-options": C.CL_ALL_DISABLED, "cl-ctrl-framesize-options": list(), "cl-ctrl-framesize-value": list(), "cl-ctrl-framesize-all-value": list(), - "cl-ctrl-framesize-all-options": CL_ALL_DISABLED, + "cl-ctrl-framesize-all-options": C.CL_ALL_DISABLED, "cl-ctrl-testtype-options": list(), "cl-ctrl-testtype-value": list(), "cl-ctrl-testtype-all-value": list(), - "cl-ctrl-testtype-all-options": CL_ALL_DISABLED, + "cl-ctrl-testtype-all-options": C.CL_ALL_DISABLED, "btn-ctrl-add-disabled": True, + "cl-normalize-value": list(), "cl-selected-options": list(), } @@ -712,6 +728,13 @@ class Layout: 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 @@ -719,46 +742,49 @@ class Layout: 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() - - @staticmethod - def _get_date(s_date: str) -> datetime: - return datetime(int(s_date[0:4]), int(s_date[5:7]), int(s_date[8:10])) - - def callbacks(self, app): def _generate_plotting_area(figs: tuple, url: str) -> tuple: - """ + """Generate the plotting area with all its content. + + :param figs: Figures to be placed in the plotting area. + :param utl: The URL to be placed in the plotting area bellow the + tables. + :type figs: tuple of plotly.graph_objects.Figure + :type url: str + :returns: tuple of elements to be shown in the plotting area. + :rtype: tuple(dcc.Graph, dcc.Graph, list(dbc.Col, dbc.Col)) """ (fig_tput, fig_lat) = figs - row_fig_tput = self.PLACEHOLDER - row_fig_lat = self.PLACEHOLDER - row_btn_dwnld = self.PLACEHOLDER + row_fig_tput = C.PLACEHOLDER + row_fig_lat = C.PLACEHOLDER + row_btn_dwnld = C.PLACEHOLDER if fig_tput: row_fig_tput = [ @@ -774,7 +800,7 @@ class Layout: 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" @@ -790,15 +816,15 @@ class Layout: class_name="me-1", children=[ dbc.InputGroupText( - style=self.URL_STYLE, - children=self._show_tooltip( + style=C.URL_STYLE, + children=show_tooltip(self._tooltips, "help-url", "URL", "input-url") ), dbc.Input( id="input-url", readonly=True, type="url", - style=self.URL_STYLE, + style=C.URL_STYLE, value=url ) ] @@ -847,6 +873,7 @@ class Layout: Output("cl-ctrl-testtype-all", "value"), Output("cl-ctrl-testtype-all", "options"), Output("btn-ctrl-add", "disabled"), + Output("cl-ctrl-normalize", "value"), Output("cl-selected", "options"), # User selection State("control-panel", "data"), # Store State("selected-tests", "data"), # Store @@ -861,6 +888,7 @@ class Layout: Input("cl-ctrl-framesize-all", "value"), Input("cl-ctrl-testtype", "value"), Input("cl-ctrl-testtype-all", "value"), + Input("cl-ctrl-normalize", "value"), Input("btn-ctrl-add", "n_clicks"), Input("dpr-period", "start_date"), Input("dpr-period", "end_date"), @@ -871,35 +899,62 @@ class Layout: def _update_ctrl_panel(cp_data: dict, store_sel: list, list_sel: list, dd_dut: str, dd_phy: str, dd_area: str, dd_test: str, cl_core: list, cl_core_all: list, cl_framesize: list, cl_framesize_all: list, - cl_testtype: list, cl_testtype_all: list, btn_add: int, - d_start: str, d_end: str, btn_remove: int, + cl_testtype: list, cl_testtype_all: list, cl_normalize: list, + btn_add: int, d_start: str, d_end: str, btn_remove: int, btn_remove_all: int, href: str) -> tuple: - """ + """Update the application when the event is detected. + + :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_dut: Input - DUTs. + :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 d_start: Date and time where the data processing starts. + :param d_end: Date and time where the data processing ends. + :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_dut: 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 d_start: str + :type d_end: str + :type btn_remove: int + :type btn_remove_all: int + :type href: str + :returns: New values for web page elements. + :rtype: tuple """ - def _gen_new_url(parsed_url: dict, store_sel: list, - start: datetime, end: datetime) -> str: - - if parsed_url: - new_url = url_encode({ - "scheme": parsed_url["scheme"], - "netloc": parsed_url["netloc"], - "path": parsed_url["path"], - "params": { - "store_sel": store_sel, - "start": start, - "end": end - } - }) - else: - new_url = str() - return new_url - - ctrl_panel = self.ControlPanel(cp_data) - d_start = self._get_date(d_start) - d_end = self._get_date(d_end) + d_start = get_date(d_start) + d_end = get_date(d_end) # Parse the url: parsed_url = url_decode(href) @@ -914,11 +969,9 @@ class Layout: if trigger_id == "dd-ctrl-dut": try: + dut = self.spec_tbs[dd_dut] options = sorted( - [ - {"label": v, "value": v} - for v in self.spec_tbs[dd_dut].keys() - ], + [{"label": v, "value": v}for v in dut.keys()], key=lambda d: d["label"] ) disabled = False @@ -933,29 +986,28 @@ class Layout: "dd-ctrl-area-value": str(), "dd-ctrl-area-options": list(), "dd-ctrl-area-disabled": True, + "dd-ctrl-test-value": str(), "dd-ctrl-test-options": list(), "dd-ctrl-test-disabled": True, "cl-ctrl-core-options": list(), "cl-ctrl-core-value": list(), "cl-ctrl-core-all-value": list(), - "cl-ctrl-core-all-options": self.CL_ALL_DISABLED, + "cl-ctrl-core-all-options": C.CL_ALL_DISABLED, "cl-ctrl-framesize-options": list(), "cl-ctrl-framesize-value": list(), "cl-ctrl-framesize-all-value": list(), - "cl-ctrl-framesize-all-options": self.CL_ALL_DISABLED, + "cl-ctrl-framesize-all-options": C.CL_ALL_DISABLED, "cl-ctrl-testtype-options": list(), "cl-ctrl-testtype-value": list(), "cl-ctrl-testtype-all-value": list(), - "cl-ctrl-testtype-all-options": self.CL_ALL_DISABLED, + "cl-ctrl-testtype-all-options": C.CL_ALL_DISABLED, }) elif trigger_id == "dd-ctrl-phy": try: dut = ctrl_panel.get("dd-ctrl-dut-value") + phy = self.spec_tbs[dut][dd_phy] options = sorted( - [ - {"label": self.label(v), "value": v} - for v in self.spec_tbs[dut][dd_phy].keys() - ], + [{"label": label(v), "value": v} for v in phy.keys()], key=lambda d: d["label"] ) disabled = False @@ -967,30 +1019,29 @@ class Layout: "dd-ctrl-area-value": str(), "dd-ctrl-area-options": options, "dd-ctrl-area-disabled": disabled, + "dd-ctrl-test-value": str(), "dd-ctrl-test-options": list(), "dd-ctrl-test-disabled": True, "cl-ctrl-core-options": list(), "cl-ctrl-core-value": list(), "cl-ctrl-core-all-value": list(), - "cl-ctrl-core-all-options": self.CL_ALL_DISABLED, + "cl-ctrl-core-all-options": C.CL_ALL_DISABLED, "cl-ctrl-framesize-options": list(), "cl-ctrl-framesize-value": list(), "cl-ctrl-framesize-all-value": list(), - "cl-ctrl-framesize-all-options": self.CL_ALL_DISABLED, + "cl-ctrl-framesize-all-options": C.CL_ALL_DISABLED, "cl-ctrl-testtype-options": list(), "cl-ctrl-testtype-value": list(), "cl-ctrl-testtype-all-value": list(), - "cl-ctrl-testtype-all-options": self.CL_ALL_DISABLED, + "cl-ctrl-testtype-all-options": C.CL_ALL_DISABLED, }) elif trigger_id == "dd-ctrl-area": try: dut = ctrl_panel.get("dd-ctrl-dut-value") phy = ctrl_panel.get("dd-ctrl-phy-value") + area = self.spec_tbs[dut][phy][dd_area] options = sorted( - [ - {"label": v, "value": v} - for v in self.spec_tbs[dut][phy][dd_area].keys() - ], + [{"label": v, "value": v} for v in area.keys()], key=lambda d: d["label"] ) disabled = False @@ -1005,15 +1056,15 @@ class Layout: "cl-ctrl-core-options": list(), "cl-ctrl-core-value": list(), "cl-ctrl-core-all-value": list(), - "cl-ctrl-core-all-options": self.CL_ALL_DISABLED, + "cl-ctrl-core-all-options": C.CL_ALL_DISABLED, "cl-ctrl-framesize-options": list(), "cl-ctrl-framesize-value": list(), "cl-ctrl-framesize-all-value": list(), - "cl-ctrl-framesize-all-options": self.CL_ALL_DISABLED, + "cl-ctrl-framesize-all-options": C.CL_ALL_DISABLED, "cl-ctrl-testtype-options": list(), "cl-ctrl-testtype-value": list(), "cl-ctrl-testtype-all-value": list(), - "cl-ctrl-testtype-all-options": self.CL_ALL_DISABLED, + "cl-ctrl-testtype-all-options": C.CL_ALL_DISABLED, }) elif trigger_id == "dd-ctrl-test": core_opts = list() @@ -1022,37 +1073,35 @@ class Layout: dut = ctrl_panel.get("dd-ctrl-dut-value") phy = ctrl_panel.get("dd-ctrl-phy-value") area = ctrl_panel.get("dd-ctrl-area-value") - cores = self.spec_tbs[dut][phy][area][dd_test]["core"] - fsizes = self.spec_tbs[dut][phy][area][dd_test]["frame-size"] - ttypes = self.spec_tbs[dut][phy][area][dd_test]["test-type"] + test = self.spec_tbs[dut][phy][area][dd_test] + cores = test["core"] + fsizes = test["frame-size"] + ttypes = test["test-type"] if dut and phy and area and dd_test: - core_opts = [ - {"label": v, "value": v} for v in sorted(cores) - ] - framesize_opts = [ - {"label": v, "value": v} for v in sorted(fsizes) - ] - testtype_opts = [ - {"label": v, "value": v}for v in sorted(ttypes) - ] + core_opts = [{"label": v, "value": v} + for v in sorted(cores)] + framesize_opts = [{"label": v, "value": v} + for v in sorted(fsizes)] + testtype_opts = [{"label": v, "value": v} + for v in sorted(ttypes)] ctrl_panel.set({ "dd-ctrl-test-value": dd_test, "cl-ctrl-core-options": core_opts, "cl-ctrl-core-value": list(), "cl-ctrl-core-all-value": list(), - "cl-ctrl-core-all-options": self.CL_ALL_ENABLED, + "cl-ctrl-core-all-options": C.CL_ALL_ENABLED, "cl-ctrl-framesize-options": framesize_opts, "cl-ctrl-framesize-value": list(), "cl-ctrl-framesize-all-value": list(), - "cl-ctrl-framesize-all-options": self.CL_ALL_ENABLED, + "cl-ctrl-framesize-all-options": C.CL_ALL_ENABLED, "cl-ctrl-testtype-options": testtype_opts, "cl-ctrl-testtype-value": list(), "cl-ctrl-testtype-all-value": list(), - "cl-ctrl-testtype-all-options": self.CL_ALL_ENABLED, + "cl-ctrl-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-ctrl-core-options"), + val_sel, val_all = sync_checklists( + options=ctrl_panel.get("cl-ctrl-core-options"), sel=cl_core, all=list(), id="" @@ -1062,8 +1111,8 @@ class Layout: "cl-ctrl-core-all-value": val_all, }) elif trigger_id == "cl-ctrl-core-all": - val_sel, val_all = self._sync_checklists( - opt = ctrl_panel.get("cl-ctrl-core-options"), + val_sel, val_all = sync_checklists( + options = ctrl_panel.get("cl-ctrl-core-options"), sel=list(), all=cl_core_all, id="all" @@ -1073,8 +1122,8 @@ class Layout: "cl-ctrl-core-all-value": val_all, }) elif trigger_id == "cl-ctrl-framesize": - val_sel, val_all = self._sync_checklists( - opt = ctrl_panel.get("cl-ctrl-framesize-options"), + val_sel, val_all = sync_checklists( + options = ctrl_panel.get("cl-ctrl-framesize-options"), sel=cl_framesize, all=list(), id="" @@ -1084,8 +1133,8 @@ class Layout: "cl-ctrl-framesize-all-value": val_all, }) elif trigger_id == "cl-ctrl-framesize-all": - val_sel, val_all = self._sync_checklists( - opt = ctrl_panel.get("cl-ctrl-framesize-options"), + val_sel, val_all = sync_checklists( + options = ctrl_panel.get("cl-ctrl-framesize-options"), sel=list(), all=cl_framesize_all, id="all" @@ -1095,8 +1144,8 @@ class Layout: "cl-ctrl-framesize-all-value": val_all, }) elif trigger_id == "cl-ctrl-testtype": - val_sel, val_all = self._sync_checklists( - opt = ctrl_panel.get("cl-ctrl-testtype-options"), + val_sel, val_all = sync_checklists( + options = ctrl_panel.get("cl-ctrl-testtype-options"), sel=cl_testtype, all=list(), id="" @@ -1106,8 +1155,8 @@ class Layout: "cl-ctrl-testtype-all-value": val_all, }) elif trigger_id == "cl-ctrl-testtype-all": - val_sel, val_all = self._sync_checklists( - opt = ctrl_panel.get("cl-ctrl-testtype-options"), + val_sel, val_all = sync_checklists( + options = ctrl_panel.get("cl-ctrl-testtype-options"), sel=list(), all=cl_testtype_all, id="all" @@ -1151,39 +1200,19 @@ class Layout: "testtype": ttype.lower() }) store_sel = sorted(store_sel, key=lambda d: d["id"]) - row_card_sel_tests = self.STYLE_ENABLED - row_btns_sel_tests = self.STYLE_ENABLED - ctrl_panel.set(ctrl_panel.defaults) - ctrl_panel.set({ - "cl-selected-options": self._list_tests(store_sel) - }) - row_fig_tput, row_fig_lat, row_btn_dwnld = \ - _generate_plotting_area( - graph_trending( - self.data, store_sel, self.layout, d_start, - d_end - ), - _gen_new_url(parsed_url, store_sel, d_start, d_end) - ) - elif trigger_id == "dpr-period": - row_fig_tput, row_fig_lat, row_btn_dwnld = \ - _generate_plotting_area( - graph_trending( - self.data, store_sel, self.layout, d_start, d_end - ), - _gen_new_url(parsed_url, store_sel, d_start, d_end) - ) + row_card_sel_tests = C.STYLE_ENABLED + row_btns_sel_tests = C.STYLE_ENABLED + if C.CLEAR_ALL_INPUTS: + ctrl_panel.set(ctrl_panel.defaults) elif trigger_id == "btn-sel-remove-all": _ = btn_remove_all - row_fig_tput = self.PLACEHOLDER - row_fig_lat = self.PLACEHOLDER - row_btn_dwnld = self.PLACEHOLDER - row_card_sel_tests = self.STYLE_DISABLED - row_btns_sel_tests = self.STYLE_DISABLED + row_fig_tput = C.PLACEHOLDER + row_fig_lat = C.PLACEHOLDER + row_btn_dwnld = C.PLACEHOLDER + row_card_sel_tests = C.STYLE_DISABLED + row_btns_sel_tests = C.STYLE_DISABLED store_sel = list() - ctrl_panel.set({ - "cl-selected-options": list() - }) + ctrl_panel.set({"cl-selected-options": list()}) elif trigger_id == "btn-sel-remove": _ = btn_remove if list_sel: @@ -1192,62 +1221,45 @@ class Layout: if item["id"] not in list_sel: new_store_sel.append(item) store_sel = new_store_sel - if store_sel: - row_fig_tput, row_fig_lat, row_btn_dwnld = \ - _generate_plotting_area( - graph_trending( - self.data, store_sel, self.layout, d_start, - d_end - ), - _gen_new_url(parsed_url, store_sel, d_start, d_end) - ) - ctrl_panel.set({ - "cl-selected-options": self._list_tests(store_sel) - }) - else: - row_fig_tput = self.PLACEHOLDER - row_fig_lat = self.PLACEHOLDER - row_btn_dwnld = self.PLACEHOLDER - row_card_sel_tests = self.STYLE_DISABLED - row_btns_sel_tests = self.STYLE_DISABLED - store_sel = list() - ctrl_panel.set({ - "cl-selected-options": list() - }) 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]) - d_start = self._get_date(url_params.get("start", list())[0]) - d_end = self._get_date(url_params.get("end", list())[0]) + d_start = get_date(url_params.get("start", list())[0]) + d_end = get_date(url_params.get("end", list())[0]) if store_sel: - row_fig_tput, row_fig_lat, row_btn_dwnld = \ - _generate_plotting_area( - graph_trending( - self.data, store_sel, self.layout, d_start, - d_end - ), - _gen_new_url( - parsed_url, store_sel, d_start, d_end - ) + row_card_sel_tests = C.STYLE_ENABLED + row_btns_sel_tests = C.STYLE_ENABLED + + if trigger_id in ("btn-ctrl-add", "url", "dpr-period", + "btn-sel-remove", "cl-ctrl-normalize"): + if store_sel: + row_fig_tput, row_fig_lat, row_btn_dwnld = \ + _generate_plotting_area( + graph_trending(self.data, store_sel, self.layout, + d_start, d_end, bool(cl_normalize)), + gen_new_url( + parsed_url, + { + "store_sel": store_sel, + "start": d_start, + "end": d_end + } ) - row_card_sel_tests = self.STYLE_ENABLED - row_btns_sel_tests = self.STYLE_ENABLED - ctrl_panel.set({ - "cl-selected-options": self._list_tests(store_sel) - }) - else: - row_fig_tput = self.PLACEHOLDER - row_fig_lat = self.PLACEHOLDER - row_btn_dwnld = self.PLACEHOLDER - row_card_sel_tests = self.STYLE_DISABLED - row_btns_sel_tests = self.STYLE_DISABLED - store_sel = list() - ctrl_panel.set({ - "cl-selected-options": list() - }) + ) + ctrl_panel.set({ + "cl-selected-options": list_tests(store_sel) + }) + else: + row_fig_tput = C.PLACEHOLDER + row_fig_lat = C.PLACEHOLDER + row_btn_dwnld = C.PLACEHOLDER + row_card_sel_tests = C.STYLE_DISABLED + row_btns_sel_tests = C.STYLE_DISABLED + store_sel = list() + ctrl_panel.set({"cl-selected-options": list()}) if ctrl_panel.get("cl-ctrl-core-value") and \ ctrl_panel.get("cl-ctrl-framesize-value") and \ @@ -1256,7 +1268,8 @@ class Layout: else: disabled = True ctrl_panel.set({ - "btn-ctrl-add-disabled": disabled + "btn-ctrl-add-disabled": disabled, + "cl-normalize-value": cl_normalize }) ret_val = [ @@ -1275,7 +1288,14 @@ class Layout: prevent_initial_call=True ) def _show_metadata_from_graphs(graph_data: dict) -> tuple: - """ + """Generates the data for the offcanvas displayed when a particular + point in a graph is clicked on. + + :param graph_data: The data from the clicked point in the graph. + :type graph_data: dict + :returns: The data to be displayed on the offcanvas and the + information to show the offcanvas. + :rtype: tuple(list, list, bool) """ try: trigger_id = loads( @@ -1345,7 +1365,16 @@ class Layout: 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: @@ -1361,4 +1390,4 @@ class Layout: continue df = pd.concat([df, sel_data], ignore_index=True) - return dcc.send_data_frame(df.to_csv, "trending_data.csv") + return dcc.send_data_frame(df.to_csv, C.TREND_DOWNLOAD_FILE_NAME)