jsonschema_diff.color¶

Convenience re-exports for the colour sub-package.

End-users can simply write:

from jsonschema_diff.color import HighlighterPipeline, LineHighlighter

Submodules¶

`LineHighlighter`	Protocol for single-line high-lighters.
`HighlighterPipeline`	Chain of `LineHighlighter()` stages.

class LineHighlighter[source]¶

Protocol for single-line high-lighters.

Concrete implementations may also override colorize_lines() for bulk operations, but colorize_line() is the only mandatory method.

abstractmethod colorize_line(line: Text) → Text[source]¶

Stylise one line in-place and return it.

Parameters:: line – A single rich.text.Text instance to be colour-styled.
Return type:: The same Text object, now containing style spans.
Raises:: NotImplementedError – Always here; concrete subclasses must override this method.

colorize_lines( lines: Sequence[Text], ) → List[Text][source]¶

Vectorised helper that stylises a sequence of lines.

The naïve fallback simply delegates to colorize_line().

class HighlighterPipeline( stages: Iterable[LineHighlighter], )[source]¶

Chain of LineHighlighter() stages.

Parameters:: stages – Iterable of LineHighlighter instances. The iterable is immediately materialised into a list so the pipeline can be reused.

Note

Each input line is passed through every stage in order.
If a stage exposes a bulk colorize_lines() method it is preferred over per-line iteration for performance.

colorize(text: str) → Text[source]¶

Return a rich Text object with all styles applied.

Parameters:

text – Multi-line string to be colourised.

Returns:

colorize_and_render( text: str, auto_line_wrapping: bool = False, ) → str[source]¶

Colourise and immediately render to ANSI.