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=48a8e5481e118155f9373e83e746e6eacb1b3c63;hb=808797d2d913eac7581a4e4cba3fb826ddbff775;hpb=ae1fe880286d7b0414664bce2b2c7c91c3f543f3 diff --git a/resources/tools/dash/app/pal/trending/layout.py b/resources/tools/dash/app/pal/trending/layout.py index 48a8e5481e..2be19f8439 100644 --- a/resources/tools/dash/app/pal/trending/layout.py +++ b/resources/tools/dash/app/pal/trending/layout.py @@ -31,20 +31,45 @@ from json import loads, JSONDecodeError 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, \ + 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 class Layout: - """ + """The layout of the dash app and the callbacks. """ 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 @@ -197,35 +222,20 @@ class Layout: def time_period(self): return self._time_period - 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", @@ -278,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", @@ -300,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", @@ -310,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", @@ -344,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", @@ -356,7 +378,7 @@ class Layout: dbc.InputGroup( [ dbc.InputGroupText( - children=self._show_tooltip( + children=show_tooltip(self._tooltips, "help-dut", "DUT") ), dbc.Select( @@ -384,7 +406,7 @@ class Layout: dbc.InputGroup( [ dbc.InputGroupText( - children=self._show_tooltip( + children=show_tooltip(self._tooltips, "help-infra", "Infra") ), dbc.Select( @@ -406,7 +428,7 @@ class Layout: dbc.InputGroup( [ dbc.InputGroupText( - children=self._show_tooltip( + children=show_tooltip(self._tooltips, "help-area", "Area") ), dbc.Select( @@ -426,7 +448,7 @@ class Layout: dbc.InputGroup( [ dbc.InputGroupText( - children=self._show_tooltip( + children=show_tooltip(self._tooltips, "help-test", "Test") ), dbc.Select( @@ -445,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" ), @@ -476,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" ), @@ -507,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" ), @@ -538,7 +560,7 @@ class Layout: class_name="gy-1", children=[ dbc.Label( - children=self._show_tooltip( + children=show_tooltip(self._tooltips, "help-normalize", "Normalize"), class_name="p-0" ), @@ -582,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( @@ -649,7 +671,19 @@ class Layout: ) 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 = { @@ -694,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 @@ -701,39 +742,42 @@ 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 @@ -756,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" @@ -773,7 +817,7 @@ class Layout: children=[ dbc.InputGroupText( style=C.URL_STYLE, - children=self._show_tooltip( + children=show_tooltip(self._tooltips, "help-url", "URL", "input-url") ), dbc.Input( @@ -858,32 +902,59 @@ class Layout: 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) @@ -936,8 +1007,7 @@ class Layout: 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 phy.keys()], + [{"label": label(v), "value": v} for v in phy.keys()], key=lambda d: d["label"] ) disabled = False @@ -1030,8 +1100,8 @@ class Layout: "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="" @@ -1041,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" @@ -1052,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="" @@ -1063,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" @@ -1074,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="" @@ -1085,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" @@ -1157,8 +1227,8 @@ class Layout: 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_card_sel_tests = C.STYLE_ENABLED row_btns_sel_tests = C.STYLE_ENABLED @@ -1170,10 +1240,17 @@ class Layout: _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, d_start, d_end) + gen_new_url( + parsed_url, + { + "store_sel": store_sel, + "start": d_start, + "end": d_end + } + ) ) ctrl_panel.set({ - "cl-selected-options": self._list_tests(store_sel) + "cl-selected-options": list_tests(store_sel) }) else: row_fig_tput = C.PLACEHOLDER @@ -1211,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( @@ -1281,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: @@ -1297,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)