Source code for abed.html.utils

"""
Utility functions for generating html. Includes functions for copying necessary 
assets.
"""

import os
import shutil

import abed

from ..conf import settings
from ..utils import mkdir



[docs]class AbedHTMLTypes:
    INDEX = ("Home", "index.html")
    METRIC_TABLES = ("Metric Tables", "metric_tables.html")
    SCALAR_TABLES = ("Scalar Tables", "scalar_tables.html")
    PROFILE_PLOTS = ("Profile Plots", "profile_plots.html")
    RANK_GRAPHS = ("Rank Graphs", "rank_graphs.html")
    RANK_TESTS = ("Rank Tests", "rank_tests.html")
    HISTOGRAMS = ("Histograms", "histograms.html")
    types = [
        INDEX,
        METRIC_TABLES,
        SCALAR_TABLES,
        PROFILE_PLOTS,
        RANK_GRAPHS,
        RANK_TESTS,
        HISTOGRAMS,
    ]




[docs]def get_data_path(filepath):
    packagedir = abed.__path__[0]
    dirname = os.path.join(os.path.dirname(packagedir), "share", "data")
    fullname = os.path.join(dirname, filepath)
    fullpath = os.path.abspath(fullname)
    return fullpath




[docs]def copy_data_file(filepath):
    src = get_data_path(filepath)
    datapath = os.path.join("assets", filepath)
    dest = os.path.join(settings.OUTPUT_DIR, "html", datapath)
    destdir = os.path.dirname(dest)
    mkdir(destdir)
    shutil.copy(src, dest)
    return datapath




[docs]def copy_auxiliary_files():
    copy_data_file("DataTables-1.10.7/media/images/favicon.ico")
    copy_data_file("DataTables-1.10.7/media/images/sort_both.png")
    copy_data_file("DataTables-1.10.7/media/images/sort_asc.png")
    copy_data_file("DataTables-1.10.7/media/images/sort_asc_disabled.png")
    copy_data_file("DataTables-1.10.7/media/images/sort_desc.png")
    copy_data_file("DataTables-1.10.7/media/images/sort_desc_disabled.png")
    copy_data_file("DataTables-1.10.7/media/images/Sorting icons.psd")