report.py

__all__ = [
    'JinjaTranslator',
    'Jinja2Report',
    'SetTranslationJinja2',
]

from base64 import b64encode
import jinja2

from trytond.pool import Pool, PoolMeta
from trytond.report.report import TranslateFactory


class JinjaExtensionsMixin():
    JINJA_EXTENSIONS = [
        'jinja2.ext.i18n',
        'jinja2.ext.do',
        'jinja2.ext.loopcontrols',
    ]

    @classmethod
    def get_extensions(cls):
        return cls.JINJA_EXTENSIONS


class JinjaTranslator(object):

    def __init__(self, method):
        self.gettext = method
        self.ngettext = method
        self.ugettext = method
        self.ungettext = method


class Jinja2Report(JinjaExtensionsMixin, metaclass=PoolMeta):

    @classmethod
    def render(cls, action, context):
        env = cls.get_environ()
        template = env.from_string(action.report_content.decode())
        return template.render(**context)

    @classmethod
    def get_environ(cls):
        env = jinja2.Environment(extensions=cls.get_extensions())
        translations = cls.get_translations()
        env.install_gettext_translations(translations)
        env.filters['b64encode'] = b64encode
        env.filters['decode'] = bytes.decode
        return env

    @classmethod
    def get_context(cls, records, header, data):
        report_context = super().get_context(records, header, data)
        report_context['attachment'] = cls.get_attachment
        report_context['attachments'] = cls.get_attachments
        return report_context

    @classmethod
    def get_translations(cls):
        translate = TranslateFactory(
            cls.__name__,
            Pool().get('ir.translation'),
        )
        return JinjaTranslator(lambda text: translate(text))

    @classmethod
    def get_attachment(cls, record, name):
        Attachment = Pool().get('ir.attachment')
        try:
            attachment, = Attachment.search([
                ('resource', '=', record),
                ('name', '=', name),
            ])
            data = attachment.data
        except ValueError:
            data = None
        finally:
            return data

    @classmethod
    def get_attachments(cls, record, name):
        Attachment = Pool().get('ir.attachment')
        try:
            attachments = Attachment.search([
                ('resource', '=', record),
                ('name', 'ilike', f"{name}%"),
            ])
            data = [attachment.data for attachment in attachments]
        except ValueError:
            data = []
        finally:
            return data


class SetTranslationJinja2(JinjaExtensionsMixin, metaclass=PoolMeta):

    __name__ = 'ir.translation.set'

    def extract_report_html(self, content):
        try:
            yield from super().extract_report_html(content)
        except Exception:
            # Because trytond tries to manage any (x|ht)ml report
            # content with the picky genshi translation extractor,
            # the set-translations process will fail in presence of
            # reports tailored for other template languages like jinja2.
            env = jinja2.Environment(extensions=self.get_extensions())
            for _, _, str_ in env.extract_translations(content.decode()):
                if str_:
                    yield str_


def register():
    Pool.register(SetTranslationJinja2, module='jinja_report', type_='wizard')