Skip to content
Snippets Groups Projects
formats.py 3.57 KiB
# -*- coding: utf-8 -*-
#
# diffoscope: in-depth comparison of files, archives, and directories
#
# Copyright © 2016 Chris Lamb <lamby@debian.org>
#
# diffoscope is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# diffoscope is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with diffoscope.  If not, see <https://www.gnu.org/licenses/>.

import logging

from ..profiling import profile

from .text import TextPresenter
from .json import JSONPresenter
from .html import HTMLPresenter, HTMLDirectoryPresenter
from .markdown import MarkdownTextPresenter
from .restructuredtext import RestructuredTextPresenter

logger = logging.getLogger(__name__)


class PresenterManager:
    _singleton = {}

    def __init__(self):
        self.__dict__ = self._singleton

        if not self._singleton:
            self.reset()

    def reset(self):
        self.config = {}

    def configure(self, parsed_args):
        FORMATS = {
            'text': {
                'klass': TextPresenter,
                'target': parsed_args.text_output,
            },
            'html': {
                'klass': HTMLPresenter,
                'target': parsed_args.html_output,
            },
            'json': {
                'klass': JSONPresenter,
                'target': parsed_args.json_output,
            },
            'markdown': {
                'klass': MarkdownTextPresenter,
                'target': parsed_args.markdown_output,
            },
            'restructuredtext': {
                'klass': RestructuredTextPresenter,
                'target': parsed_args.restructuredtext_output,
            },
            'html_directory': {
                'klass': HTMLDirectoryPresenter,
                'target': parsed_args.html_output_directory,
            },
        }

        self.config = {
            k: v for k, v in FORMATS.items() if v['target'] is not None
        }

        # If no output specified, default to printing --text output to stdout
        if not self.config:
            FORMATS['text']['target'] = '-'
            self.config['text'] = FORMATS['text']

        logger.debug(
            "Will generate the following formats: %s",
            ", ".join(self.config.keys()),
        )

    def output(self, difference, parsed_args, has_differences):
        if difference is None:
            return

        for name, data in self.config.items():
            logger.debug("Generating %r output at %r", name, data['target'])

            # As a special case for text format, write an empty file instead of
            # an empty diff (with headers including the path). This lets people
            # test if the file is empty.
            if not has_differences and name == 'text':
                target = data['target']
                if target != '-':
                    open(target, 'w').close()
                continue

            with profile('output', name):
                data['klass'].run(data, difference, parsed_args)

    def compute_visual_diffs(self):
        """
        Don't waste time computing visual differences if we won't use them.
        """

        return any(
            x['klass'].supports_visual_diffs for x in self.config.values()
        )