tabulardelta.formatters.detailed_text_formatter module

class tabulardelta.formatters.detailed_text_formatter.DetailedTextFormatter(errors: bool = True, warnings: bool = True, infos: bool = True, column_changes: bool = True, row_overview: bool = True, value_changes: int = 5, row_examples: int = 3, value_change_height: int = 5)

Bases: object

Implements Formatter protocol for detailed report of single comparison.

Tries to show as much information as possible, without overwhelming the user.

Methods

format(delta: TabularDelta) -> str:

Formats comparison result

column_changes: bool = True

Whether to show column and type changes in the report.

errors: bool = True

Whether to show errors in the report.

format(delta: TabularDelta) → str

Formats comparison result.

Arguments:

delta TabularDelta:

Metadata and result of a comparison.

Returns str:

Detailed comparison report.

infos: bool = True

Whether to show additional information in the report.

row_examples: int = 3

How many examples to show for added and removed rows in the report.

0 to disable.

row_overview: bool = True

Whether to show graphical row matching in the report.

value_change_height: int = 5

Maximum lines to show per value change in the report.

Uses line-by-line diff if cells are too large.

value_changes: int = 5

How many value changes per column to show in the report.

0 to disable.

warnings: bool = True

Whether to show warnings in the report.