File: differ.py

package info (click to toggle)
sphinxcontrib-websupport 2.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,112 kB
  • sloc: python: 1,351; javascript: 635; makefile: 53; sh: 7; ansic: 1
file content (82 lines) | stat: -rw-r--r-- 2,471 bytes parent folder | download
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
"""A differ for creating an HTML representations of proposal diffs."""

from __future__ import annotations

import html
import re
from difflib import Differ


class CombinedHtmlDiff:
    """Create an HTML representation of the differences between two pieces
    of text.
    """
    highlight_regex = re.compile(r'([\+\-\^]+)')

    def __init__(self, source, proposal):
        proposal = html.escape(proposal)

        differ = Differ()
        self.diff: list[str] = list(differ.compare(
            source.splitlines(keepends=True),
            proposal.splitlines(keepends=True),
        ))

    def make_text(self) -> str:
        return '\n'.join(self.diff)

    def make_html(self) -> str:
        """Return the HTML representation of the differences between
        `source` and `proposal`.

        :param source: the original text
        :param proposal: the proposed text
        """
        html = []
        diff = self.diff[:]
        line = diff.pop(0)
        next = diff.pop(0)
        while True:
            html.append(self._handle_line(line, next))
            line = next
            try:
                next = diff.pop(0)
            except IndexError:
                html.append(self._handle_line(line))
                break
        return ''.join(html).rstrip()

    def _handle_line(self, line: str, next: str | None = None) -> str:
        """Handle an individual line in a diff."""
        prefix = line[0]
        text = line[2:]

        if prefix == ' ':
            return text
        elif prefix == '?':
            return ''

        if next is not None and next[0] == '?':
            tag = prefix == '+' and 'ins' or 'del'
            text = self._highlight_text(text, next, tag)
        css_class = prefix == '+' and 'prop-added' or 'prop-removed'

        return f'<span class="{css_class}">{text.rstrip()}</span>\n'

    def _highlight_text(self, text: str, next: str, tag: str) -> str:
        """Highlight the specific changes made to a line by adding
        <ins> and <del> tags.
        """
        next = next[2:]
        new_text: list[str] = []
        start = 0
        for match in self.highlight_regex.finditer(next):
            new_text.extend((
                text[start:match.start()],
                f'<{tag}>',
                text[match.start():match.end()],
                f'</{tag}>',
            ))
            start = match.end()
        new_text.append(text[start:])
        return ''.join(new_text)