python-okreport 1.0.1

simple report automatic rendering

okreport: simple report automatic rendering

Installation

pip install python-okreport

Usage

from okreport import Var, Paragraph, Report

class ResultX(Var):
    def parse(self, result, conf, env):  # noqa
        return result['x']
    
    
class ResultY(Var):
    def parse(self, result, conf, env):  # noqa
        return result['y']
    
    
class ResultSum(Var):
    def parse(self, result, conf, env):  # noqa
        return result['x'] + result['y']

class ConfX(Var):
    def parse(self, result, conf, env):  # noqa
        return conf['x']


class ConfY(Var):
    def parse(self, result, conf, env):  # noqa
        return conf['y']


class ConfSum(Var):
    def parse(self, result, conf, env):  # noqa
        return conf['x'] + conf['y']
    
    
class ResultParagraph(Paragraph):
    """
    In result, x = {{ x }}, y = {{ y }}, sum is {{ sum }}.
    """
    x = ResultX()
    y = ResultY()
    sum = ResultSum()
    
    def get_template_text(self, result, conf, env):  # noqa
        return self.__doc__


class ConfParagraph(Paragraph):
    """
    In conf, x = {{ x }}, y = {{ y }}, sum is {{ sum }}.
    """
    x = ConfX()
    y = ConfY()
    sum = ConfSum()
    
    def get_template_text(self, result, conf, env):  # noqa
        return self.__doc__


class MyReport(Report):
    """
    {{ p1 }}
    {{ p2 }}
    """
    p1 = ResultParagraph()
    p2 = ConfParagraph()
    
    def get_template_text(self, result, conf, env):  # noqa
        return self.__doc__


result = {'x': 1, 'y': 2}
conf = {'x': 3, 'y': 4}
my_report = MyReport()
text = my_report.render(result, conf, None)
print(text)