File: formats.py

package info (click to toggle)
diffoscope 310
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 11,320 kB
  • sloc: python: 17,206; sh: 116; makefile: 97; xml: 36; javascript: 2
file content (125 lines) | stat: -rw-r--r-- 4,002 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
#
# diffoscope: in-depth comparison of files, archives, and directories
#
# Copyright © 2017-2022 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 os
import logging

from ..profiling import profile
from ..utils import format_bytes

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 presenter 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)

            size = "n/a"
            if os.path.isfile(data["target"]):
                size = format_bytes(os.path.getsize(data["target"]))

            logger.debug(
                "Generated %r output at %r (size: %s)",
                name,
                data["target"],
                size,
            )

    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()
        )