json_objects.py

 
import json
import enum
import functools
 
# todo: shouldn't I call super().__init__() or similar to make sure that I
# execute code from mother classes?? This seems to only have been done for
# some of the subclasses here...
 
"""
Define datatypes for later serialization by json
"""
 
# todo: write a short overview over the many classes and their relationships here
 
# ==============================================================================
# Data classes
# ==============================================================================
 
 
class JsonBase:
 
    """
    Base object for all json-serializable objects of the validation suite
    """
 
 
class Revision(JsonBase):
 
    """
    Contains information about a specific revision
    """
 
    def __init__(
        self,
        label,
        git_hash=None,
        creation_date=None,
        packages=None,
        creation_timezone=None,
    ):
        """
        Create a new Revision object and fill all members
        """
 
        
        self.label = label
 
        
        self.creation_date = creation_date
 
        
        self.creation_timezone = creation_timezone
 
        
        self.git_hash = git_hash
 
        
        self.most_recent = False
 
        
        self.packages = [] if (packages is None) else packages
 
 
class Revisions(JsonBase):
 
    """
    Container for a list of revisions
    """
 
    def __init__(self, revisions):
        """
        Create a new Revisions object and fill all members
        """
 
        
        self.revisions = revisions
 
 
class Script(JsonBase):
 
    """
    Contains information about a script and its execution output
    """
 
    def __init__(
            self,
            name,
            path,
            status,
            log_url=None,
            return_code=None,
            input=None,
            output=None,
            issues=None
    ):
        """
        Create a new Script object and fill all members
        """
 
        
        self.name = name
        
        self.path = path
        
        self.status = status
        
        self.log_url = log_url
        
        self.return_code = return_code
        
        self.input = input
        
        self.output = output
        
        if not issues:
            issues = []
        self.issues = issues
 
 
class PlotFile(JsonBase):
 
    """
    Wrapper for a file containing a set of plots, only
    root files up to now
    """
 
    def __init__(self, package, title, rootfile, plots, description=""):
        """
        Create a new PlotFile object and fill all members
        """
 
        
        self.package = package
        
        self.title = title
        
        self.rootfile = rootfile
        
        self.plots = plots
        
        self.description = description
        
        self.n_shifter_plots = sum([not plot.is_expert for plot in self.plots])
 
 
class Plot(JsonBase):
 
    """
    Wrapper for one specific plot.
    """
 
    def __init__(
        self,
        is_expert=False,
        description=None,
        check=None,
        contact=None,
        width=None,
        height=None,
        issue=None,
    ):
        """
        Create a new Plot object and fill all members
        """
 
        
        self.is_expert = is_expert
        
        self.description = description
        
        self.check = check
        
        self.contact = contact
        
        self.width = width
        
        self.height = height
        
        if not issue:
            issue = []
        self.issue = issue
 
 
class NTuple(JsonBase):
 
    """
    Wrapper for NTuple lists. This is not a graphical plot, but a list of
    values
    """
 
    def __init__(self, is_expert=False, description=None, check=None):
        """
        Create a new NTuple object and fill all members
        """
 
        
        self.is_expert = is_expert
        
        self.description = description
        
        self.check = check
 
 
class HtmlContent(JsonBase):
 
    """
    Wrapper for user HTML Content. This is not a graphical plot but HTML
    code which will be directly output on the validation website.
 
    """
 
    def __init__(self, is_expert=False, description=None, check=None):
        """
        Create a new NTuple object and fill all members
        """
 
        
        self.is_expert = is_expert
        
        self.description = description
        
        self.check = check
 
 
class Package(JsonBase):
 
    """
    One high-level package of the validation suites which contains a set of
    scripts and output plot files
    """
 
    def __init__(self, name, plotfiles=None, scriptfiles=None, fail_count=0):
        """
        Create a new NTuple object and fill all members
        """
 
        if not plotfiles:
            plotfiles = []
        if not scriptfiles:
            scriptfiles = []
 
        
        self.name = name
        
        self.plotfiles = plotfiles
        
        self.scriptfiles = scriptfiles
        
        self.visible = True
        
        self.fail_count = fail_count
 
 
class ComparisonState(enum.Enum):
 
    """
    Enum to classify the comparison result of two validation plots
    """
 
    
    NotCompared = "not_compared"
    
    NotSupported = "not_supported"
    
    FailureTechnical = "technical_failure"
    
    FailureStastical = "statistical_failure"
    
    Equal = "equal"
 
 
class ComparisonResult(JsonBase):
 
    """
    Contains the comparison result of two plots
    """
 
    def __init__(self, state, chi2):
        """
        Create a new ComparisonResult object and fill all members
        """
 
        
        self.state = state
        
        self.chi2 = chi2
 
 
class ComparisonPlotFile(PlotFile):
 
    """
    Contains information about a file containing plots and the comparison which
    have been performed for the content of this file
    """
 
    def __init__(
        self,
        package,
        title,
        rootfile,
        compared_revisions=None,
        plots=None,
        has_reference=False,
        ntuples=None,
        html_content=None,
        description=None,
    ):
        """
        Create a new ComparisonPlotFile object and fill all members
        """
 
        if not plots:
            plots = []
        if not ntuples:
            ntuples = []
        if not html_content:
            html_content = []
 
        super().__init__(
            package, title, rootfile, plots, description=description
        )
        
        self.compared_revision = compared_revisions
        
        self.ntuples = ntuples
        
        self.html_content = html_content
 
        
        self.has_reference = has_reference
 
        
        self.comparison_error = len(
            [plt for plt in self.plots if plt.comparison_result == "error"]
        )
        
        self.comparison_error_shifter = len(
            [
                plt
                for plt in self.plots
                if (not plt.is_expert) and plt.comparison_result == "error"
            ]
        )
        
        self.comparison_warning = len(
            [plt for plt in self.plots if plt.comparison_result == "warning"]
        )
        
        self.comparison_warning_shifter = len(
            [
                plt
                for plt in self.plots
                if (not plt.is_expert) and plt.comparison_result == "warning"
            ]
        )
 
        
        self.n_shifter_ntuples = sum(
            [not tuple.is_expert for tuple in self.ntuples]
        )
 
        
        self.show_shifter = bool(
            self.n_shifter_plots or self.n_shifter_ntuples or self.html_content
        )
 
 
class ComparisonPlot(Plot):
 
    """
    One individual plot including its comparison outcome.
    """
 
    def __init__(
        self,
        title,
        comparison_result=None,
        png_filename=None,
        pdf_filename=None,
        contact=None,
        description=None,
        check=None,
        is_expert=None,
        plot_path=None,
        comparison_text=None,
        height=None,
        width=None,
        warnings=None,
    ):
        """
        Create a new ComparisonPlot object and fill all members
        """
 
        # todo: move more into the base class
        super().__init__(
            is_expert=is_expert,
            description=description,
            check=check,
            contact=contact,
            height=height,
            width=width,
        )
        
        self.title = title
 
        
        self.comparison_result = comparison_result
 
        
        self.comparison_text = comparison_text
 
        
        self.png_filename = png_filename
 
        
        self.pdf_filename = pdf_filename
 
        
        self.plot_path = plot_path
 
        
        if warnings is None:
            warnings = []
        self.warnings = warnings
 
 
class ComparisonNTuple(NTuple):
 
    """
    Comparison outcome for NTuples
    """
 
    def __init__(
        self,
        title,
        contact=None,
        description=None,
        check=None,
        is_expert=None,
        json_file_path=None,
    ):
        """
        Create a new ComparisonNTuple object and fill all members
        """
 
        # todo: move more into the base class
        super().__init__(
            is_expert=is_expert, description=description, check=check
        )
        
        self.title = title
        
        self.contact = contact
        
        self.json_file_path = json_file_path
 
 
class ComparisonHtmlContent(HtmlContent):
 
    """
    Compiled HTLM Content
    """
 
    def __init__(
        self,
        title,
        contact=None,
        description=None,
        check=None,
        is_expert=None,
        html_content=None,
    ):
        """
        Create a new ComparisonNTuple object and fill all members
        """
 
        # todo: move more into the base class
        super().__init__(
            is_expert=is_expert, description=description, check=check
        )
        
        self.title = title
        
        self.contact = contact
        
        self.html_content = html_content
 
 
class ComparisonPackage(Package):
 
    """
    Information about a Package which was used in a comparison operation
    """
 
    def __init__(
        self, name, plotfiles=None, scriptfiles=None, ntuplefiles=None
    ):
        """
        Create a new ComparisonPackage object and fill all members
        """
 
        if not plotfiles:
            plotfiles = []
        if not scriptfiles:
            scriptfiles = []
        if not ntuplefiles:
            ntuplefiles = []
 
        super().__init__(name, plotfiles=plotfiles, scriptfiles=scriptfiles)
 
        
        self.comparison_error = sum([pf.comparison_error for pf in plotfiles])
        
        self.comparison_error_shifter = sum(
            [pf.comparison_error_shifter for pf in plotfiles]
        )
        
        self.comparison_warning = sum(
            [pf.comparison_warning for pf in plotfiles]
        )
        
        self.comparison_warning_shifter = sum(
            [pf.comparison_warning_shifter for pf in plotfiles]
        )
 
 
class ComparisonRevision(Revision):
 
    """
    Revision information enriched by the information gained during
    a comparison.
    """
 
    def __init__(self, label, git_hash=None, creation_date=None, color=None):
        """
        Create a new ComparisonRevision object and fill all members
        """
 
        # todo: creation_date
        super().__init__(label, git_hash=git_hash, creation_date=None)
        
        self.color = color
 
 
class Comparison(JsonBase):
 
    """
    Contains information and plots generated for comparisons
    between revisions
    """
 
    def __init__(self, revisions=None, packages=None):
        """
        Create a new ComparisonRevision object and fill all members
        """
 
        if not revisions:
            revisions = []
        if not packages:
            packages = []
 
        
        self.revisions = revisions
        
        self.packages = packages
        sorted_revs = sorted(revisions, key=lambda x: x.label)
        
        self.label = functools.reduce(
            lambda x, y: x + "_" + y.label, sorted_revs, ""
        )[1:]
 
 
# ==============================================================================
# Functions
# ==============================================================================
 
 
def dump(file_name, obj):
    """
    Output a tree of objects into a json file
    """
 
    with open(file_name, "w+") as f:
        json.dump(dump_rec(obj), f, sort_keys=True, indent=4)
 
 
def dumps(obj):
    """
    Convert a tree of python objects into a json file
    """
 
    kk = dump_rec(obj)
    return json.dumps(kk, sort_keys=True, indent=4)
 
 
def dump_rec(top_object):
    """
    Recursive generating of dictionary from a tree
    of JsonBase objects
    """
 
    this_dict = {}
    # iterate through the dictionary of the top object
    for (k, v) in top_object.__dict__.items():
 
        # list which needs special handing ?
        if isinstance(v, list):
            obj_list = []
            for it in v:
                # one of our object's in the list, which needs
                # special treatment?
                if isinstance(it, JsonBase):
                    # yen, recurse in to the object
                    obj_list.append(dump_rec(it))
                else:
                    # no, just add value to list
                    obj_list.append(it)
 
            # store compiled list with corresponding key
            this_dict[k] = obj_list
        # one of our objects, which might be nested and
        # needs special treatment ?
        elif isinstance(v, JsonBase):
            this_dict[k] = dump_rec(v)
        # treat enum classes
        elif isinstance(v, enum.Enum):
            this_dict[k] = v.value
        # regular value, just store with correct key
        else:
            this_dict[k] = v
    return this_dict