Source code for sciunit.converters

"""
Classes for converting from the output of a model/data comparison
to the value required for particular score type.
"""

from string import Template
from typing import Callable

from .scores import BooleanScore, Score


class Converter(object):
    """
    Base converter class.
    Only derived classes should be used in applications.
    """

    @property
    def description(self):
        if self.__doc__:
            s = " ".join([si.strip() for si in self.__doc__.split("\n")]).strip()
            t = Template(s)
            s = t.safe_substitute(self.__dict__)
        else:
            s = "No description available"
        return s

    def _convert(self, score: Score) -> None:
        """Takes the score attribute of a score instance and recasts it as instance of another score type.

        Args:
            score (Score): An instance of Score.

        Raises:
            NotImplementedError: Not implemented if not overrided.
        """
        raise NotImplementedError(
            (
                "The '_convert' method for %s "
                "it not implemented." % self.__class__.__name__
            )
        )

    def convert(self, score: Score) -> Score:
        """Convert a type of score to another type of score.

        Args:
            score (Score): The original score.

        Returns:
            Score: The converted score.
        """
        new_score = self._convert(score)
        new_score.set_raw(score.get_raw())
        for key, value in score.__dict__.items():
            if key not in ["score", "_raw"]:
                setattr(new_score, key, value)
        return new_score


class NoConversion(Converter):
    """
    Applies no conversion.
    """

    def _convert(self, score: Score) -> Score:
        return score


class LambdaConversion(Converter):
    """
    Converts a score according to a lambda function.
    """

    def __init__(self, f: Callable):
        """f should be a lambda function

        Args:
            f (Callable): The Lambda function that will be used for the score conversion.
        """
        self.f = f

    def _convert(self, score: Score) -> Score:
        return score.__class__(self.f(score))


class AtMostToBoolean(Converter):
    """
    Converts a score to pass if its value is at most $cutoff, otherwise False.
    """

    def __init__(self, cutoff: int):
        self.cutoff = cutoff

    def _convert(self, score: Score) -> BooleanScore:
        return BooleanScore(bool(score <= self.cutoff))


class AtLeastToBoolean(Converter):
    """
    Converts a score to Pass if its value is at least $cutoff, otherwise False.
    """

    def __init__(self, cutoff: int):
        self.cutoff = cutoff

    def _convert(self, score: Score) -> BooleanScore:
        return BooleanScore(score >= self.cutoff)


class RangeToBoolean(Converter):
    """
    Converts a score to Pass if its value is within the range
    [$low_cutoff,$high_cutoff], otherwise Fail.
    """

    def __init__(self, low_cutoff: int, high_cutoff: int):
        self.low_cutoff = low_cutoff
        self.high_cutoff = high_cutoff

    def _convert(self, score: Score) -> BooleanScore:
        return BooleanScore(self.low_cutoff <= score <= self.high_cutoff)