looper 1.5.1__py3-none-any.whl → 1.6.0a1__py3-none-any.whl

looper/html_reports_project_pipestat.py

@@ -1,269 +0,0 @@
-import glob
-import logging
-import os
-
-from eido import read_schema
-from peppy.const import *
-
-from ._version import __version__ as v
-from .const import *
-from .exceptions import PipelineInterfaceConfigError
-from .html_reports_pipestat import (
-    HTMLReportBuilder,
-    fetch_pipeline_results,
-    get_jinja_env,
-    render_jinja_template,
-    save_html,
-)
-from .pipeline_interface import PipelineInterface
-
-_LOGGER = logging.getLogger("looper")
-
-
-class HTMLReportBuilderProject(object):
-    """Generate HTML summary report for project/samples"""
-
-    def __init__(self, prj):
-        """
-        The Project defines the instance.
-
-        :param looper.Project prj: Project with which to work/operate on
-        :param bool project_level: whether to generate a project-level
-            pipeline report
-        """
-        super(HTMLReportBuilderProject, self).__init__()
-        self.prj = prj
-        self.j_env = get_jinja_env()
-        self.output_dir = self.prj.output_dir
-        self.reports_dir = os.path.join(self.output_dir, "reports")
-        _LOGGER.debug(f"Reports dir: {self.reports_dir}")
-
-    def __call__(self, piface_source):
-        """
-        Generate HTML report.
-
-        :param str piface_source: path to the pipeline interface defining
-            connection to the pipeline to generate the report for
-        :return str: path to the index page of the generated HTML report
-        """
-        # Generate HTML report
-        self.prj_piface_source = piface_source
-        self.prj_piface = PipelineInterface(config=self.prj_piface_source)
-        self.amendments_str = (
-            "_".join(self.prj.amendments) if self.prj.amendments else ""
-        )
-        self.pipeline_reports = os.path.join(
-            self.reports_dir,
-            f"{self.prj_piface.pipeline_name}_{self.amendments_str}"
-            if self.prj.amendments
-            else self.prj_piface.pipeline_name,
-        )
-        pifaces = self.prj.project_pipeline_interfaces
-        selected_pipeline_pifaces = [
-            p for p in pifaces if p.pipeline_name == self.prj_piface.pipeline_name
-        ]
-        schema_path = self.prj.get_schemas(
-            selected_pipeline_pifaces, OUTPUT_SCHEMA_KEY
-        )[0]
-        self.schema = read_schema(schema_path)[0]
-        self.index_html_path = os.path.join(
-            self.pipeline_reports, f"{self.prj.name}.html"
-        )
-        linked_sample_reports = {}
-        html_report_builder = HTMLReportBuilder(prj=self.prj)
-        for sample_piface_source in self.prj.linked_sample_interfaces[
-            self.prj_piface_source
-        ]:
-            # Do the stats and object summarization.
-            pipeline_name = PipelineInterface(sample_piface_source).pipeline_name
-            # run the report builder. a set of HTML pages is produced
-            report_path = html_report_builder(
-                pipeline_name=pipeline_name, project_index_html=self.index_html_path
-            )
-            if pipeline_name in linked_sample_reports:
-                raise PipelineInterfaceConfigError(
-                    f"Duplicate pipeline_names found in pipeline interfaces "
-                    f"defined for samples in this project: {pipeline_name}"
-                )
-            linked_sample_reports[pipeline_name] = os.path.relpath(
-                report_path, self.pipeline_reports
-            )
-            _LOGGER.info(
-                f"Sample-level '{pipeline_name}' pipeline HTML report: "
-                f"{report_path}"
-            )
-        print(f"{linked_sample_reports}")
-        sample_reps_parent = os.path.join(self.pipeline_reports, "sample_reports.html")
-        sample_reports_parent_relpath = os.path.relpath(
-            sample_reps_parent, self.pipeline_reports
-        )
-        navbar = self.create_navbar(
-            navbar_links=self.create_navbar_links(
-                sample_reports_parent_relpath=sample_reports_parent_relpath
-            ),
-            index_html_relpath=os.path.basename(self.index_html_path),
-        )
-        save_html(
-            path=sample_reps_parent,
-            template=self.create_sample_reports_parent(
-                linked_sample_reports=linked_sample_reports,
-                navbar=navbar,
-                footer=self.create_footer(),
-            ),
-        )
-        self.create_index_html(navbar=navbar, footer=self.create_footer())
-        return self.index_html_path
-
-    def create_navbar_links(self, sample_reports_parent_relpath):
-        template_vars = dict(
-            status_html_page=None,
-            dropdown_keys_objects=None,
-            objects_html_page=None,
-            samples_html_page=None,
-            sample_names=None,
-            all_samples=None,
-            all_objects=None,
-            sample_reports_parent=sample_reports_parent_relpath,
-            project_report=None,
-        )
-        _LOGGER.debug(f"navbar_links.html | template_vars:\n{template_vars}")
-        return render_jinja_template("navbar_links.html", self.j_env, template_vars)
-
-    def create_sample_reports_parent(self, linked_sample_reports, navbar, footer):
-        template_vars = dict(
-            navbar=navbar,
-            footer=footer,
-            header="Linked sample pipelines",
-            labels=list(linked_sample_reports.keys()),
-            pages=list(linked_sample_reports.values()),
-        )
-        _LOGGER.debug(f"navbar_list_parent.html | template_vars: \n{template_vars}")
-        return render_jinja_template(
-            "navbar_list_parent.html", self.j_env, template_vars
-        )
-
-    def create_footer(self):
-        """
-        Renders the footer from the templates directory
-
-        :return str: footer HTML
-        """
-        return render_jinja_template("footer.html", self.j_env, dict(version=v))
-
-    def create_navbar(self, navbar_links, index_html_relpath):
-        """
-        Creates the navbar using the provided links
-
-        :param str navbar_links: HTML list of links to be inserted into a navbar
-        :return str: navbar HTML
-        """
-        template_vars = dict(navbar_links=navbar_links, index_html=index_html_relpath)
-        return render_jinja_template("navbar.html", self.j_env, template_vars)
-
-    def create_index_html(self, navbar, footer):
-        project_stat_results = fetch_pipeline_results(
-            project=self.prj,
-            pipeline_name=self.prj_piface.pipeline_name,
-            inclusion_fun=lambda x: x not in OBJECT_TYPES,
-            casting_fun=str,
-        )
-        return self.create_sample_html(project_stat_results, navbar, footer)
-
-    def create_sample_html(self, sample_stats, navbar, footer):
-        """
-        Produce an HTML page containing all of a sample's objects
-        and the sample summary statistics
-
-        :param dict sample_stats: pipeline run statistics for the current sample
-        :param str navbar: HTML to be included as the navbar in the main summary page
-        :param str footer: HTML to be included as the footer
-        :return str: path to the produced HTML page
-        """
-        if not os.path.exists(self.pipeline_reports):
-            os.makedirs(self.pipeline_reports)
-
-        sample_name = self.prj.name
-        html_page = os.path.join(self.pipeline_reports, f"{sample_name}.html".lower())
-
-        psms = self.prj.get_pipestat_managers(project_level=True)
-        psm = psms[self.prj_piface.pipeline_name]
-        flag = psm.get_status()
-        if not flag:
-            button_class = "btn btn-secondary"
-            flag = "Missing"
-        else:
-            try:
-                flag_dict = BUTTON_APPEARANCE_BY_FLAG[flag]
-            except KeyError:
-                button_class = "btn btn-secondary"
-                flag = "Unknown"
-            else:
-                button_class = flag_dict["button_class"]
-                flag = flag_dict["flag"]
-        highlighted_results = fetch_pipeline_results(
-            project=self.prj,
-            pipeline_name=self.prj_piface.pipeline_name,
-            sample_name=None,
-            inclusion_fun=lambda x: x == "file",
-            highlighted=True,
-        )
-
-        for k in highlighted_results.keys():
-            highlighted_results[k]["path"] = os.path.relpath(
-                highlighted_results[k]["path"], self.pipeline_reports
-            )
-
-        links = []
-        file_results = fetch_pipeline_results(
-            project=self.prj,
-            pipeline_name=self.prj_piface.pipeline_name,
-            sample_name=None,
-            inclusion_fun=lambda x: x == "file",
-        )
-        for result_id, result in file_results.items():
-            desc = (
-                self.schema[result_id]["description"]
-                if "description" in self.schema[result_id]
-                else ""
-            )
-            links.append(
-                [
-                    f"<b>{result['title']}</b>: {desc}",
-                    os.path.relpath(result["path"], self.pipeline_reports),
-                ]
-            )
-        image_results = fetch_pipeline_results(
-            project=self.prj,
-            pipeline_name=self.prj_piface.pipeline_name,
-            sample_name=None,
-            inclusion_fun=lambda x: x == "image",
-        )
-        figures = []
-        for result_id, result in image_results.items():
-            figures.append(
-                [
-                    os.path.relpath(result["path"], self.pipeline_reports),
-                    result["title"],
-                    os.path.relpath(result["thumbnail_path"], self.pipeline_reports),
-                ]
-            )
-
-        template_vars = dict(
-            report_class="Project",
-            navbar=navbar,
-            footer=footer,
-            sample_name=sample_name,
-            links=links,
-            figures=figures,
-            highlighted_results=highlighted_results,
-            button_class=button_class,
-            sample_stats=sample_stats,
-            flag=flag,
-            pipeline_name=self.prj_piface.pipeline_name,
-            amendments=self.prj.amendments,
-        )
-        _LOGGER.debug(f"sample.html | template_vars:\n{template_vars}")
-        save_html(
-            html_page, render_jinja_template("sample.html", self.j_env, template_vars)
-        )
-        return html_page