sqlcompyre.report.writers.file module

class sqlcompyre.report.writers.file.FileWriter(formatter: Formatter)

Bases: Writer

Writer that outputs reports to a set of files.

The files are written to the .compyre directory which is created if it does not yet exist. Each report is then written to a dedicated file in that directory: the name of each file is the report’s identifier and the extension is set to the formatter’s configured file extension.

Methods

write(reports[, hide_matching_columns])

Write the provided reports to this writer's sink.

write(reports: dict[str, Report], hide_matching_columns: bool = False) → None

Write the provided reports to this writer’s sink.

Args:

reports: A set of reports, mapped from an identifier to the report. hide_matching_columns: Whether to hide columns from the report which show a perfect

(i.e. 100%) match rate.