core.html_diff

Diffs HTML fragments. Nice to show what changed between two revisions of a document for an arbitrary user.

Examples: .. code-block:: pycon

>>> from htmldiff import render_html_diff

>>> render_html_diff('Foo <b>bar</b> baz', 'Foo <i>bar</i> baz')
'<div class="diff">Foo <i class="tagdiff_replaced">bar</i> baz</div>'

>>> render_html_diff('Foo bar baz', 'Foo baz')
'<div class="diff">Foo <del>bar</del> baz</div>'

>>> render_html_diff('Foo baz', 'Foo blah baz')
'<div class="diff">Foo <ins>blah</ins> baz</div>'

copyright:

3. 2011 by Armin Ronacher

license:

BSD

Attributes

Position
_leading_space_re
_diff_split_re

Classes

StreamDiffer

A class that can diff a stream of Genshi events. It will inject

Functions

diff_genshi_stream(→ genshi.core.Stream)	Renders a creole diff for two texts.
render_html_diff(→ markupsafe.Markup)	Renders the diff between two HTML fragments.
parse_html(→ genshi.input.ET)	Parse an HTML fragment into a Genshi stream.

Module Contents

core.html_diff.Position: TypeAlias = tuple[str | None, int, int]

core.html_diff._leading_space_re

core.html_diff._diff_split_re

core.html_diff.diff_genshi_stream(old_stream: genshi.core.Stream, new_stream: genshi.core.Stream) → genshi.core.Stream

Renders a creole diff for two texts.

core.html_diff.render_html_diff(old: str, new: str, wrapper_element: str = 'div', wrapper_class: str = 'diff') → markupsafe.Markup

Renders the diff between two HTML fragments.

core.html_diff.parse_html(html: str, wrapper_element: str = 'div', wrapper_class: str = 'diff') → genshi.input.ET

Parse an HTML fragment into a Genshi stream.

class core.html_diff.StreamDiffer(old_stream: genshi.input.ET, new_stream: genshi.input.ET)

A class that can diff a stream of Genshi events. It will inject <ins> and <del> tags into the stream. It probably breaks in very ugly ways if you pass a random Genshi stream to it. I’m not exactly sure if it’s correct what creoleparser is doing here, but it appears that it’s not using a namespace. That’s fine with me so the tags the StreamDiffer adds are also unnamespaced.

_old: list[StreamEvent]

_new: list[StreamEvent]

_result: list[StreamEvent]

_stack: list[str]

_context: str | None

context(kind: str | None) → Iterator[None]

inject_class(attrs: genshi.core.Attrs, classname: str) → genshi.core.Attrs

append(type: genshi.core.StreamEventKind, data: Any, pos: Position) → None

text_split(text: str) → list[str]

cut_leading_space(s: str) → tuple[str, str]

mark_text(pos: Position, text: str, tag: str) → None

diff_text(pos: Position, old_text: str, new_text: str) → None

replace(old_start: int, old_end: int, new_start: int, new_end: int) → None

delete(start: int, end: int) → None

insert(start: int, end: int) → None

unchanged(start: int, end: int) → None

enter(pos: Any, tag: Any, attrs: dict[str, Any]) → None

enter_mark_replaced(pos: Position, tag: str, attrs: genshi.core.Attrs) → None

leave(pos: Position, tag: str) → bool

leave_all() → None

block_process(events: list[StreamEvent]) → None

process() → None

get_diff_stream() → genshi.core.Stream