display_utils.py

import IPython.display


def with_colour(display_string: str, colour_string: str):
    return IPython.display.HTML(
        f'<text style="color: {colour_string}">{display_string}</text>'
    )


def table(*headers):
    """
    Initializes a Markdown table. Takes the headers of the table as input

    :return: a table builder
    :rtype: Markdown_Table
    """
    return Markdown_Table(*headers)


def br():
    """Returns a line break."""
    return with_colour(f"<br>", "gray")


class Markdown_Table:
    def __init__(self, *headers):
        self._separator = " | "
        self._str = self._separator.join(headers)
        self._columns = len(headers)
        self._are_dividers_applied = False

    def set_alignments(self, *alignments):
        """
        p
        """
        if self._are_dividers_applied:
            raise RuntimeError("Alignments have already been applied.")
        self._append_row(*alignments)
        self._are_dividers_applied = True

    def append_row(self, *row_entries):
        """
        Appends a row of entries to the current table. The number of entries must match the number of columns (defined by the number of
        headers initially provided.)
        :return: The table builder, for fluent chaining
        """
        if not self._are_dividers_applied:
            dividers = ["---" for _ in range(0, self._columns)]
            self.set_alignments(*dividers)

        return self._append_row(*row_entries)

    def _append_row(self, *row_entries):
        if self._columns != len(row_entries):
            raise ValueError(
                f"Table has {self._columns} columns but only {len(row_entries)} entries were provided"
            )

        self._str = self._str + "\n"
        self._str = self._str + self._separator.join([str(e) for e in row_entries])

        return self  # Permit fluent chaining

    def close(self):
        """
        Completes the table and returns a displayable Markdown object
        """
        return IPython.display.Markdown(self._str)


class classproperty(
    object
):  # https://stackoverflow.com/questions/5189699/how-to-make-a-class-property
    def __init__(self, f):
        self.f = f

    def __get__(self, obj, owner):
        return self.f(owner)


class _this(object):
    @classproperty
    def value(self):
        raise ValueError("A required simulation parameter wasn't set.")


class set(object):
    @classproperty
    def this(self):
        return _this()