Summary

DataFrameComparison.summary([...])

Generate a summary of all aspects of the comparison.

class diffly.summary.Summary(

comparison: DataFrameComparison,

show_perfect_column_matches: bool,

top_k_column_changes: int,

sample_k_rows_only: int,

show_sample_primary_key_per_change: bool,

left_name: str,

right_name: str,

slim: bool,

hidden_columns: list[str] | None,

)

Container object for generating a summary of the comparison of two data frames.

Note

Do not initialize this object directly. Instead, use DataFrameComparison.summary().

Summary.format([pretty])

Format this summary for printing.